Skip to content

Commit

Permalink
Add dev notes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
justinsilvestre committed Feb 15, 2024
1 parent 613214c commit e655b08
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,16 @@ The following license information applies to the texts in the [texts](./texts) f
[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/
[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg

## development

To run the app locally:

1. Install packages from the repository root directory
> npm install
2. Run prebuild script
> npm run prebuild
3. Run Next.js dev server
> npm run dev
After making changes to the files in the `texts/` directory, you may need to **run the prebuild script again**.

0 comments on commit e655b08

Please sign in to comment.