Skip to content

Commit

Permalink
Add note about using Node 12
Browse files Browse the repository at this point in the history
  • Loading branch information
nichhk committed May 25, 2022
1 parent 8b6de42 commit af8f68c
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,23 @@

### 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](https://account.mapbox.com/auth/signin/) 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
- Install Node 12. You can use [nvm](https://github.com/nvm-sh/nvm) to install this particular version of Node.
- From this directory, `npm run setup` to install front end dependencies and create an `.env` file
- get a [Mapbox](https://account.mapbox.com/auth/signin/) 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
- 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
Expand Down

0 comments on commit af8f68c

Please sign in to comment.