Skip to content

Commit

Permalink
Add build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tannewt committed Jun 28, 2020
1 parent 2ab7a10 commit aa120d0
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Expand Up @@ -2,3 +2,18 @@ This is the source for https://electioncal.us which provides election
timeline information and makes it available through the website and
icalendar files.

# Building the site

The site is statically hosted by GitHub. To test it locally, first install the
python requirements with:

pip install -r requirements.txt

Once those are installed, build the site with:

python scripts/build_site.py

This generates all of files served statically under the `site` folder. To serve
them locally do:

python -m http.server --directory site/ 8080

0 comments on commit aa120d0

Please sign in to comment.