-
Notifications
You must be signed in to change notification settings - Fork 5
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
Adding more detailed documentation of the API, build process, etc #23
base: dev
Are you sure you want to change the base?
Conversation
|
||
`python expenditures/app.py` | ||
|
||
Once running the app should auto-restart if you make any changes to the code base. The |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should probably either finish the sentence or drop the hanging The
. 😝
| ENV | The environment that you're working in which should be "dev" | | ||
| cert | The firebase certificate used to connect to the firebase facts database (see below) | | ||
| AWS_ACCESS_KEY_ID | AWS API Key | | ||
| AWS_SECRET_ACCESS_KEY | AWS Secret Key | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be nice to provide an example of setting these env vars. Maybe even add a .env-sample
file to the repo?
|
||
Questions about how the deploy works? Talk to Steve (steve_stearns on the digital team Slack) | ||
Be sure that when you set up your local environment that the JSON for the firebase | ||
certificate is properly escaped. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a little bit of clarification here? Should it arrive properly escaped?
Also maybe add a "(see below)" after "firebase certificate".
files. No muss. No fuss. | ||
| Variable | Description | | ||
|:----------------------|:------------------------------------------------------------------------------------| | ||
| ENV | The environment that you're working in which should be "dev" | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For my own clarification, once we get a local option that doesn't use AWS, should this value still be dev
locally? Should we specify a value of local
when I've got Redis running for local dev in place of AWS?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure that makes sense to have redis in place of dynamo locally as it uses two different technologies. That said I think it'd make sense to just keep it as dev, whichever way we go with the local environment.
No description provided.