Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.16 KB

README.md

File metadata and controls

56 lines (32 loc) · 2.16 KB
Raw

CodeforNRV.org

The website for the Code for New River Valley Brigade

Goals

  1. Explain what Code for NRV is and the type of work we do.
  2. To celebrate our events, projects, and discussions!
  3. Encourage current and new members to participate with clear ways to get involved.
  4. To have this site be easily reused by other Brigades just starting out.

Tech

Built using Jekyll, Bootstrap, and the CfAPI.

Contributing

Submitting an Issue

We use GitHub Issues to track bugs and features. We've included several of our open GitHub Issues right on our homepage using the Civic Tech Issue Finder.

Running the Site Locally on Your Computer

To run the site locally on your own computer (most helpful for previewing your own changes), you will need Jekyll installed (click here for Jekyll installation instructions.)

Fork and clone the repository, then run the following command in the root directory of the repo:

jekyll serve

or

jekyll serve --watch which will watch for changes to files.

Your computer should now be serving your local copy of the site at:

http://0.0.0.0:4000.

Sharing Your Changes Using Jekit

You can use the nifty Jekit app to preview changes you make to this site.

To do this, fork this repo, and commit your changes on a branch to your fork. You can then preview what your changes look like by navigating to:

https://jekit.codeforamerica.org/USERNAME/sfbrigade.github.io/BRANCHNAME/

For a basic example of its usage, if GitHub user @lolname has made changes to the projects page on their fork (on the master branch), they can preview their changes using Jekit by going to:

https://jekit.codeforamerica.org/lolname/sfbrigade.github.io/master/projects

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch.
  3. Implement your feature or bug fix.
  4. Commit and push your changes.
  5. Submit a pull request.