darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-08-23 07:46:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

Revise final sections of the README

Browse Source 
This makes a few additional changes to curb the length of this file,
by moving length documentation (the picture is large) into a separate
file, where other documentation could go. It also corrects the section
on requirements, and attempts to make it more concise.
This commit is contained in:
Ben Thorner
2021-02-22 17:15:09 +00:00
parent 864f4bef66
commit 423b4c7812
2 changed files with 14 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -64,33 +64,20 @@ make bootstrap
make test make test
``` ```
## Updating application dependencies ## Common tasks
`requirements.txt` file is generated from the `requirements-app.txt` in order to pin ### Updating application dependencies
versions of all nested dependencies. If `requirements-app.txt` has been changed (or
we want to update the unpinned nested dependencies) `requirements.txt` should be
regenerated with
``` `requirements.txt` is generated from the `requirements.in` in order to pin versions of all nested dependencies. If `requirements.in` has been changed, run `make freeze-requirements` to regenerate it.
make freeze-requirements
```
`requirements.txt` should be committed alongside `requirements-app.txt` changes. ### Automatically rebuild the frontend assets
If you want the front end assets to re-compile on changes, leave this running in a separate terminal from the app
## Automatically rebuild the frontend assets
If you want the front end assets to re-compile on changes, leave this running
in a separate terminal from the app
```shell ```shell
npm run watch npm run watch
``` ```
## Working with static assets ## Further docs
When running locally static assets are served by Flask at http://localhost:6012/static/… - [Working with static assets](docs/static-assets.md)
When running on preview, staging and production there’s a bit more to it:
![notify-static-after](https://user-images.githubusercontent.com/355079/50343595-6ea5de80-051f-11e9-85cf-2c20eb3cdefa.png)

7
docs/static-assets.md Normal file
View File

@@ -0,0 +1,7 @@
# Working with static assets
When running locally static assets are served by Flask at http://localhost:6012/static/…
When running on preview, staging and production there’s a bit more to it:
![notify-static-after](https://user-images.githubusercontent.com/355079/50343595-6ea5de80-051f-11e9-85cf-2c20eb3cdefa.png)