Switch to an Org page

README.md

@@ -1,2 +1,182 @@
-# free-nonprofit-starter-website
-A Github Pages template for nonprofits seeking a starter website. Includes email capture (Mailchimp) and online donations (DonorBox)
+## A Free Website Template for Nonprofits
+We want to help introduce the nonprofit community to the powerful world of open source development. Just follow the step-by-step instructions below, and in less than an hour your grassroots nonprofit will have a live, no-cost website complete with online donation capabilities.
+
+But most importantly, by hosting your site and its code on Github you'll allow volunteers to easily contribute to ongoing development of your site.  
+
+___
+#### No Coding Skills Required  
+If you're the type of person that can set up email on your smartphone, you likely have all the skills needed to take advantage of this template. This isn't that hard...you can do it! :smile:
+
+___
+#### Help Others Help You  
+Github makes it crazy simple for people to help with your site. Whether it's volunteers or paid contractors, you're always just a few clicks away from accepting improvements.       
+___
+
+#### Features  
+1. Accept online donations  
+2. Capture email addresses to begin building your supporter database  
+
+#### Demo  
+[https://smartergiving.github.io/free-nonprofit-starter-website/](https://smartergiving.github.io/free-nonprofit-starter-website/)
+
+#### Screenshot  
+![Screenshot](screenshots/screenshot.png?raw=true "Free Nonprofit Starter Template Screenshot")
+___
+#### Benefits  
+1. **Open Source**  
+    Your site and its code will be hosted on Github. This makes it easy for any developer, designer, or copywriter to help customize your site.
+
+2. **Totally Free**  
+    No upfront nor ongoing costs.   
+
+3. **Payments by Stripe**   
+    [Stripe](https://stripe.com/gallery) is used by many [tools for nonprofits](https://stripe.com/docs/integrations#fundraising). When you require a more robust fundraising solution than DonorBox offers, switching is easy.    
+___
+
+### Getting Started  
+*Note:* This project does require rolling up your sleeves a bit. If you're looking for a more user-friendly service (albeit paid), we're big fans of [Squarespace](https://squarespace.com) and [Wix](http://www.wix.com/).  
+#### Overview  
+___
+1. Create Github accounts
+2. Fork the repo
+3. Enter your organization's info in `_config.yml`
+4. Create DonorBox and Stripe accounts (for online donations)  
+5. Create TinyLetter account (for email capture)  
+6. Enter DonorBox and TinyLetter credentials in `_config.yml`
+7. Suggested next steps  
+
+#### Detailed Tutorial
+___
+**Step 1** Create Github accounts  
+
+1. Get started by clicking the green "SignUp" button at the top of this page  
+
+2. Enter your signup information as instructed and click "Create an account"  
+
+3. On the second page ("Choose your Plan"), check the box that says "Help me set up an organization"  
+![Screenshot](screenshots/signup.jpg?raw=true "Free Nonprofit Starter Template Screenshot")  
+4. Follow the remaining steps. Don't forget to confirm your email address.  
+
+___
+**Step 2** Fork the repo  
+
+1. Click the "Fork" button at the top of this page
+
+2. When prompted, click the Organization you just set up  
+
+3. Change the name of the repo by clicking "Settings" in the right-hand menu. Name the repo `<orgname>.github.io` (where `<orgname>` is the Organization name you chose for Github) and click "Rename". For example, for us here at Smartergiving, we would name the repo `smartergiving.github.io`.  
+![Settings](screenshots/settings.jpg?raw=true "Free Nonprofit Starter Template Screenshot")
+4. Your site can now be viewed at `<orgname>.github.io`
+
+___
+**Step 3** Enter your organization's info
+
+1. Click the `_config.yml` file  
+![SignUp](screenshots/config.jpg?raw=true "Create an Account")  
+2. Click the edit button  
+![Edit](screenshots/edit.jpg?raw=true "Edit")  
+
+3. Replace the example text with your organization's information  
+![Enter Information](screenshots/enter_info.jpg?raw=true "Enter Information")
+
+4. When finished, "commit" the changes by entering a commit message (e.g. "Update config") in the "Commit changes" box at the bottom of the page. Leave the other options as they are, and click the "Commit changes" button.  
+![Commit](screenshots/commit.jpg?raw=true "Commit")
+
+5. Preview your site at ` <orgname>.github.io`.
+6. Continue to adjust `_config.yml` as needed.
+
+___
+**Step 4** Create DonorBox account
+
+1. Go to [DonorBox](https://donorbox.org/orgs/new) and create an account.  
+2. We suggest using the "Organization Sign Up" option, which will walk you through creating a [Stripe](https://stripe.com/gallery) account. Stripe handles the actual credit card processing.  
+![DonorBox SignUp](screenshots/donorbox_signup.jpg?raw=true "DonorBox SignUp")
+
+3. Follow the prompts to add your first campaign.
+4. **Important**: Be sure you fully understand the [risks of accepting online donations](https://donorbox.org/nonprofit-blog/on-fraud-prevention/).  
+
+___
+**Step 5** Create TinyLetter account  
+
+1. Go to [TinyLetter](http://tinyletter.com/) and create an account by clicking the "Sign Up Free" button  
+
+___
+**Step 6** Enter DonorBox and TinyLetter credentials  
+
+1. Edit the `_config.yml` file and enter your credentials in the appropriate spots
+
+  + **Find your DonorBox campaign name**  
+After you've created a campaign, on your dashboard click "edit" for the campaign you'd like to include on your site. 2/3rds of the way down the page you'll see a "Form URL" box. This is where you'll find your Donorbox Username for `_config.yml`  
+![DonorBox](screenshots/donorbox.jpg?raw=true "DonorBox")   
+
+  + **Find your TinyLetter username**  
+Your TinyLetter Username can be found on your Profile page.  
+![TinyLetter](screenshots/tinyletter.jpg?raw=true "TinyLetter")
+
+___
+**Step 7** Suggested next steps  
+
+1. Ask for help from your supporters or the open source community.  
+    a. [HashtagCharity](https://hashtagcharity.org/charities)  
+    b. [Idealist](http://www.idealist.org/add-org)  
+    c. [Reddit (/r/nonprofitprojects)](https://www.reddit.com/r/nonprofitprojects)
+
+2. Continue development on your own  
+    a. [Set up your local machine](http://ramonaharrison.github.io/jekyll/pixyll/technical/git/github/2015/03/09/how-i-built-my-blog/) (follow steps 1 and 2)  
+    b. Download [Github Desktop](https://desktop.github.com/) and [Atom](https://atom.io/) ([tutorial](https://github.com/jwsy/example-website/tree/master#initial-setup))
+
+3. Need Help? Consider attending one of Github's [workshops](http://patchwork.github.io/) or [online trainings](https://training.github.com/classes/)
+
+___
+#### Themes
+Select an alternative color scheme by changing the `theme:` option in `_config.yml`.  
+
+![Alternative Themes](screenshots/themes.png?raw=true "Alternative Themes")  
+
+___
+#### Extras  
+If you know a little HTML/CSS, the project is built on Bootstrap and offers the full suite of [Bootstrap components](https://smartergiving.github.io/free-nonprofit-starter-website/components-bootstrap.html)
+___
+
+
+### TODOs
+- [ ] CNAME and custom domain instructions
+- [ ] Add cleanup items to tutorial
+  - [ ] Delete gh-pages branch
+  - [ ] Swap README for a "post-launch" one
+- [ ] Open graph metadata
+- [ ] Troubleshooting tips
+
+### Future
+- [ ] Google Analytics
+- [ ] Mailchimp
+- [ ] Paypal
+
+___
+
+### Credits  
+Many thanks to [Xiaoying Riley](https://www.linkedin.com/in/xiaoying) of [3rd Wave Media](http://themes.3rdwavemedia.com/) for the wonderful [open source template](http://themes.3rdwavemedia.com/website-templates/devaid-free-bootstrap-theme-developers/) from which this project is based. License: [Creative Commons Attribution 3.0 License (CC BY 3.0)](http://creativecommons.org/licenses/by/3.0/).
+
+### License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Chad Kruse, SmarterGiving
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

_config.yml

@@ -0,0 +1,71 @@
+#INTRO
+#Set up is quick and easy. Simply replace any example text with your nonprofit's information.
+#To leave a field blank, simply remove everything after the colon (:) or place a hashtag (#) at the start of the line.
+#If you see '> # Enter on the next line', be sure the next line remains indented two spaces.
+
+#REQUIRED
+org_name: Project Example
+org_summary: > # Enter your summary on the next line. Be sure to indent by two spaces.
+  A mobile-friendly Github Pages template designed to help grassroots nonprofits get a website online quickly
+org_full_description: > # Enter your description on the next line. Be sure to indent by two spaces.
+  Ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate.
+
+#OPTIONAL
+#Non US-address support coming soon
+org_general_email_inbox: [email protected]
+org_street_address: 1355 Market Street #Please include suite number on the line below
+org_address_suite: Suite 900
+org_city: San Francisco
+org_state: CA
+org_zip: > # Enter zip on next line. Be sure to indent by two spaces.
+  94103
+org_phone: > # Enter phone on next line. Be sure to indent by two spaces.
+  (123) 456-7890
+
+#SOCIAL MEDIA
+org_twitter_username: smartergiving
+org_facebook_username: smartergiving
+org_instagram_username:
+
+#TAX STATUS
+#Your site will display an appropriate message below the Donate section
+#If your organization is fiscally sponsored, enter true below and add your sponsor's name. Otherwise enter false.
+fiscal_sponsor: false
+fiscal_sponsor_name:
+#If your organization is currently registered as a 501(c)3 organization, enter true below. Otherwise enter false. Enter false if you have a fiscal sponsor.
+501c3: true
+
+#ONLINE DONATIONS & EMAIL SIGNUPS
+#To use these services, enter the required usernames. For further instructions, consult the README file.
+#If you do not wish to use a service, simply remove everything after the colon (:), leaving the item blank
+donorbox_campaign_name: free-template-demo
+tinyletter_username: interestingnonprofits
+
+#SEARCH ENGINES
+#Changing this next setting to 'true' will allow your site to be indexed by search engines (like Google)
+publish: false
+
+#THEME
+#Select one of the five color schemes (default, one, two, three, or four)
+theme: default
+
+# *** DO NOT CHANGE ANYTHING BELOW THIS LINE ***
+
+# Unless you know what you're doing, no need to change anything below
+# Build settings
+baseurl: "" # the subpath of your site, e.g. /blog/
+markdown: kramdown
+kramdown:
+  input: GFM
+
+sass:
+    sass_dir: assets/_sass
+    style: compressed
+
+#Features under development
+#These are not yet fully supported, but should give you a head start if you know what you're doing
+paypal_button_id: #Not yet available
+smartergiving_id: #Not yet available
+#mailchimp_embed_code: > # Enter Mailchimp post url on next line.
+#  //getkyn.us5.list-manage.com/subscribe/post?u=1407d7ee4cd0d47986cd54315&id=cdc32b64fe
+#mailchimp_spam_guard: b_753395b9f963c9ea2d6980b7c_9e1559c2f0

_includes/footer.html

@@ -0,0 +1,7 @@
+<!-- ******FOOTER****** -->
+<footer class="footer">
+  <div class="container text-center">
+    <small class="copyright">A free, <a href="https://github.com/smartergiving/free-nonprofit-starter-website" target="_blank">open source</a> project from the folks at <a href="http://smartergiving.org" target="_blank">SmarterGiving</a></small><br>
+    <small class="copyright">Designed with <i class="fa fa-heart"></i> by <a href="http://themes.3rdwavemedia.com" target="_blank">Xiaoying Riley</a></small>
+  </div><!--//container-->
+</footer><!--//footer-->

_includes/head.html

@@ -0,0 +1,27 @@
+<head>
+    <title>{% if page.title %}{{ page.title }}{% else %}{{ site.org_name }}{% endif %}</title>
+    <!-- Meta -->
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    {% if site.publish == true %}
+      <meta name="robots" content="index, follow">
+    {% else %}
+      <meta name="robots" content="noindex, nofollow">
+    {% endif %}
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="{% if site.summary %}{{ site.summary | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
+    <link rel="shortcut icon" href="favicon.ico">
+    <link href='https://fonts.googleapis.com/css?family=Lato:300,400,300italic,400italic' rel='stylesheet' type='text/css'>
+    <link href='https://fonts.googleapis.com/css?family=Montserrat:400,700' rel='stylesheet' type='text/css'>
+    <!-- Global CSS -->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css" integrity="sha512-dTfge/zgoMYpP7QbHy4gWMEGsbsdZeCXz7irItjcC3sPUFtf0kuFbDz/ixG7ArTxmDjLXDmezHubeNikyKGVyQ==" crossorigin="anonymous">
+    <!-- Plugins CSS -->
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.4.0/css/font-awesome.min.css">
+    <!-- Theme CSS -->
+    <link rel="stylesheet" href="assets/css/main.css">
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+      <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+    <![endif]-->
+</head>

_includes/scripts.html

@@ -0,0 +1,5 @@
+<!-- Javascript -->
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js" integrity="sha512-K1qjQ+NcF2TYO/eI3M6v8EiNYZfA95pQumfvcVrTHtwQVDG+aHRqLi/ETn2uB+1JqwYqVG3LIvdm9lj6imS/pQ==" crossorigin="anonymous"></script>
+<script src="//cdnjs.cloudflare.com/ajax/libs/jquery-scrollTo/2.1.0/jquery.scrollTo.min.js"></script>
+<script type="text/javascript" src="assets/js/main.js"></script>

_layouts/default.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->
+<!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->
+<!--[if !IE]><!--> <html lang="en"> <!--<![endif]-->
+
+  {% include head.html %}
+
+  <body data-spy="scroll">
+
+    {{ content }}
+
+    {% include footer.html %}
+
+    {% include scripts.html %}
+
+  </body>
+
+</html>