Skip to content

Commit 566a116

Browse files
committed
docs(dev): add notes to developers
Describe some common commands and patterns to ease development of LwimiLinks
1 parent 5d8a103 commit 566a116

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,17 @@ Docker Volumes for production:
9797
.env file
9898

9999
* EMAIL_BACKEND_CONSOLE=False
100+
101+
## Notes to Developers
102+
103+
- When setting up the app (from scratch or from a wipe), the following commands should be run:
104+
- (Optional) `make build`
105+
- `make up` - wait for the database to start, then hit Control-C
106+
- `make migrate`
107+
- `make up` - runs the app
108+
- To wipe the database, use `make down`
109+
- The Django admin interface is at `/admin/`
110+
- An admin user can be created through `make create-super-user`
111+
- To run a single module of tests, you can pass the Makefile `module` variable on the command line. For instance, to run
112+
only tests defined in [`test_document_admin.py`](./app/general/tests/test_document_admin.py), run
113+
`make test module=general.tests.test_document_admin`

0 commit comments

Comments
 (0)