Skip to content

Commit

Permalink
Merge pull request #1207 from hackforla/1205-update-clientreadmemd-to…
Browse files Browse the repository at this point in the history
…-tell-devs-to-use-node-12

Add note about using Node 12
  • Loading branch information
ardada2468 authored May 25, 2022
2 parents 8b6de42 + 280aba2 commit 327b6c7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,25 @@

### 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 [nvm](https://github.com/nvm-sh/nvm).
- Install Node 12: `nvm install 12`
- Switch to using Node 12: `nvm use 12`
- 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. Alternatively, you can [bring up](https://github.com/hackforla/311-data/blob/dev/docs/server_setup.md) your own local server and use that.

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 327b6c7

Please sign in to comment.