Skip to content

Commit 1ab574c

Browse files
authored
Update readme
The rationale of this change is to update readme and add an example env file to help cloning and starting to work on app easier. Changelog - Add env.example, - Update readme
1 parent 6f25244 commit 1ab574c

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.env.example

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
REACT_APP_NEWS_API_KEY=xxx
2+
REACT_APP_CHART_KEY=xxx
3+
REACT_APP_API_URL=xxx

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,20 @@ After 309 tests, app has 92% line coverage.
4040
<img src="https://i.paste.pics/b12e46504282e9d9b4926e0973310563.png" width="32.5%" alt='user favorites page' />
4141
<img src="https://i.paste.pics/ee9714ddf3d385495e45321f15351189.png" width="32.5%" alt='login register page' />
4242
</p>
43+
44+
## Environment Variables
45+
46+
**NEWS_API_KEY**: News API key is from NewYorkTimes API, more information about how to get started with their API can be found in their [documentation](https://developer.nytimes.com/get-started).
47+
48+
**CHART_KEY**: Chart key is from [financialModelingPrep API](https://site.financialmodelingprep.com/developer/docs/).
49+
50+
**API_URL**: URL for the API I created for the [project](https://github.com/urlDev/mern-react-times-api) (e.g. to help users login, save symbols). Because of the hosting issues with Heroku, I decided to host my APIs in `fly.io` and make the URL as a variable for future inconveniences.
51+
52+
## Scripts
53+
54+
`npm run start` to start the app,
55+
`npm run test` or `npm t` to run tests in watch mode,
56+
`npm run build` to build the app,
57+
`npm run cover` to run test coverage,
58+
`npm run eject` to eject the app.
59+

0 commit comments

Comments
 (0)