Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 1.35 KB

dev_setup.md

File metadata and controls

28 lines (19 loc) · 1.35 KB

Developer Setup

Docker Version

This sets up the site with a consistent runtime environment, and requires Docker to be installed and running. This will build a container and put you into a Bash shell where you can run Linux commands.

  1. Navigate to the base of this repo in your terminal or command prompt
  2. Launch the Bash shell:
    • Linux/Mac: sh bin/dev_shell.sh
    • Windows: bin\dev_shell.bat
  3. Install dependencies (first time only or when package.json changes): npm install
  4. Run the dev server: npm run start
  5. View the site in your browser at http://localhost:8080

From here, changes to files locally will rebuild the site.

Local Version

This uses whatever NPM and Node version you have installed on your machine, and might use fewer system resources than the Docker install (i.e. better for lower powered machines). If something is not working using this setup, use the Docker version to see if the problem exists there.

With that said, this setup has been tested with Node.js 20.8.x.

  1. Navigate to the base of this repo in your terminal or command prompt
  2. Install dependencies (first time only or when package.json changes): npm install
  3. Start server: npm run start
  4. View the site in your browser at http://localhost:8080

From here, changes to files will rebuild the site.