Skip to content

README.md

Latest commit

 

History

History
27 lines (19 loc) · 1.21 KB

README.md

File metadata and controls

27 lines (19 loc) · 1.21 KB
Raw

Getting Started

Setting up the project for the first time?

  • From this directory, npm run setup to install front end dependencies and create an .env file
  • get a Mapbox API token and add that to your .env file as the MAPBOX_TOKEN
  • get the API_URL from a team member and add that to your .env file

Setup complete!

Development

  • From this directory, npm start to check your .env file and start webpack dev server

Your browser should open to 0.0.0.0:3000 and the site should render. Webpack will detect saved code changes, rebuild the bundle in memory, and update the site in your browser.

Stop webpack dev server with Ctrl-C.

Useful commands

npm run setup                 # install dependencies listed in package.json and check .env file
npm run check-env             # checks .env file exists and has all required keys
npm start                     # check .env file and start webpack dev server
npm run dev                   # start webpack dev server (no .env check)
npm run build                 # run webpack in production mode - output is placed in dist directory
npm run lint                  # lint javascript in client directory