Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.72 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.72 KB

CodeforGreensboro Website

Public facing website for the CodeforGreensboro brigade of CodeforAmerica

Design

Mockups for our design can be checked out on our Figma page.

Architecture

This is a static website that is built using Gatsby

It is hosted on GitHub Pages

Please refer to either of those resources, if you aren't particularly familiar with how they work. They have wonderful tutorials which are suited for beginners, novices, and experienced devs.

Getting Started

To start working on the code, gitif thats what you're in to, or you just want to take a look.

You will need:

Once you have those installed:

  1. Clone the project by opening up a terminal and typing:
    git clone https://github.com/codeforgso/website.git
  2. Install all of the project's dependencies:
    cd website
    then:
    npm install
  3. Run
    gatsby develop
    and code your heart out.

Contributing

We track our work on a Trello Board

More Technical Contributions

When developing on the code base, please create a branch locally and submit a pull request which describes what your pr does (Bonus points if it knocks out a bug or fixes an issue!). We will only merge to the master branch via pull requests, so please do not push to master.

More Generalized Contributions

Please see the Trello board for tasks which we need help with.