Skip to content
This repository has been archived by the owner on Jul 31, 2020. It is now read-only.

Latest commit

 

History

History
79 lines (48 loc) · 2.38 KB

setup.md

File metadata and controls

79 lines (48 loc) · 2.38 KB
Raw

Setup

Your Environment

Make sure to have a modern version of Node installed:

  1. Official builds (every platform)

  2. Homebrew (Mac/Apple):

     brew install node

  3. Scoop (Windows):

     scoop install nodejs

  4. Docker: Not yet? Let's build a Dockerfile + Docker Compose file

Second off, we will need to download/install/build Git for your machine:

  1. Mac: Github Desktop Install

  2. Windows: Github Desktop Install

  3. Homebrew (Mac/Apple)

     brew install git

Cloning The Repo

Changes to the site should be done through contributing to the repo in an open source manner. If giving back to open source is new, we highly recommend this guide by the fine folks at GitHub.

  1. Sign up or sign in to your GitHub Account

  2. Navigate to the Code For Greensboro repository

  3. On the far right there will be a button labeled 'Fork', click it.

  4. Fork the repository into your account's repository list.

If you are using the GitHub Desktop client (Easy):

  1. Use the GitHub Desktop client to download the code to your computer
  2. Stop here, you are all set, code away!

If you are using the command line (Harder):

  1. Clone the freshly forked repository to your computer.

  2. Check the upstream remote by 'cd ing' into the project's root folder and running the following command:

     git remote -v

    The output should read:

    origin [email protected]:{your GitHub username}/codeforgso.github.io.git (fetch)
    origin [email protected]:{your GitHub username}/codeforgso.github.io.git (push)

    OR

    origin https://github.com/{your GitHub username}/codeforgso.github.io.git (fetch)
    origin https://github.com/{your GitHub username}/codeforgso.github.io.git (push)

Dependencies

The project is a Node application. All dependencies can be installed using the following command in the root of the repo. Note that you may need to install an npm extension if you have not yet.

    npm install

Running the Project

With all code installed, the project can be started using the following:

  npm run dev