Giter Club home page Giter Club logo

spn's Introduction

spn

Build Status

Source code for the website behind SinglePayerNOW, a political advocacy group for the advancement of single payer healthcare.

Contributor's Guide

Building Locally

Installing depdencies:

sudo apt-get install ruby-dev
sudo gem install jekyll jekyll-paginate rake

Build the site:

jekyll build

You can alternatively use jekyll to serve the site locally without having to push it to GitHub:

jekyll serve

Contributing

This site uses a simple multi-branch deployment model to separate the deployed code on the master branch from the trunk development branch, develop.

Notable branches:

  • develop: This is the "master" branch of the repo, if you will. When you are starting a new feature, branch from here. This is also the branch against which you will create pull requests. Furthermore, Travis listens for changes on this branch to deploy to master.
  • master: The contents of this branch are served to the public by GitHub pages and are built automatically by Travis when a pull request to develop is merged. Do not touch this branch for any reason.

Before you clone the repository, there are some settings you should set:

git config --global push.default current
git config --global user.name "<insert your name here>"
git config --global user.email "<add your email address you use to sign into GH here"

To get started developing, first clone the repo if you have not already done so:

git clone https://github.com/wheelerlaw/spn.git
cd spn

If you have just cloned the repo, you can probably skip this next step. Otherwise, checkout develop and pull the latest changes:

git checkout develop
git pull

Create your feature branch off of develop. There is no enforced naming convention for feature branches, but most branch names are all lower case with words separated by underscores. PLEASE PLEASE PLEASE make it descriptive as to what the feature is (please):

git checkout -b your_feature_branch

Build (and serve up) the website locally and navigate to http://localhost:4000/ to view your changes before you push them:

jekyll serve

Now commit your changes and push them:

git add -A
git commit -m "Add some human readable, descriptive commit message."
git push -u 

Note: -u is only needed on the git push if the branch does not exist in origin (the repo in Github).

Now, go to Github and create a pull request against develop. Get an admin (@wheelerlaw) to sign off on your changes and merge the PR into develop.

Wait a few minutes and your changes will show up on the site. You might need to clear your browser cache.

spn's People

Contributors

wheelerlaw avatar

Watchers

James Cloos avatar  avatar

spn's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.