brigade

(β˜… 102)

The Code for America Brigade Website

  • .flake8
  • .gitignore
  • .node-version
  • .sass-lint.yml
  • .travis.yml
  • app.json
  • LICENSE
  • manage.py
  • package-lock.json
  • package.json
  • Procfile
  • README-Monitor.md
  • README-Project-Search.md
  • README.md
  • requirements-dev.txt
  • requirements.txt
  • runtime.txt
  • webpack.config.js

# Installation Guide

1. Get the code
git clone https://github.com/codeforamerica/brigade

Downloads the entire project code from GitHub to your computer.

cd brigade

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew install node

Installs the pre-built package via Homebrew β€” no source build required.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python3 -m venv env

Runs the Python script (or module).

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation