Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation for local client and server setup #1318

Merged
merged 2 commits into from
Aug 17, 2022
Merged

Updated documentation for local client and server setup #1318

merged 2 commits into from
Aug 17, 2022

Conversation

edwinjue
Copy link
Member

Fixes #1315

  • Up to date with dev branch
  • Branch name follows guidelines
  • All PR Status checks are successful
  • Peer reviewed and approved

Any questions? See the getting started guide

…erver in /client/README.md and included CORS policy setting to prevent client-side errors when connecting to local API server in /server/.env.example
@edwinjue edwinjue linked an issue Aug 16, 2022 that may be closed by this pull request
2 tasks
Copy link
Member

@nichhk nichhk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this Edwin! One small comment. I'm approving the PR now, so you can commit the fix and then merge the PR yourself.

client/README.md Outdated
@@ -7,7 +7,7 @@
- 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.
- 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 (if you are running your own local server, set API_URL to 'http://localhost:5000')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: `API_URL` instead of API_URL for consistency

Copy link
Member Author

@edwinjue edwinjue Aug 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, added the back ticks around API_URL for consistency

@edwinjue edwinjue merged commit 5fca637 into hackforla:dev Aug 17, 2022
@edwinjue edwinjue deleted the 1315-update-documentation-for-local-client-and-server-setup branch August 17, 2022 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for local client and server setup
2 participants