mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-07-25 20:18:38 +02:00
Update and organize documentation
This commit is contained in:
parent
d88fa8fb3e
commit
2386258159
8 changed files with 98 additions and 64 deletions
37
docs/developer/README.md
Normal file
37
docs/developer/README.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
# Development
|
||||
========================
|
||||
|
||||
If you're new to Django, see [Getting Started with Django](https://www.djangoproject.com/start/) for an introduction to the framework.
|
||||
|
||||
## Local Setup
|
||||
|
||||
* Install Docker <https://docs.docker.com/get-docker/>
|
||||
* Initialize the application:
|
||||
|
||||
```shell
|
||||
cd src
|
||||
docker-compose build
|
||||
```
|
||||
* Run the server: `docker-compose up`
|
||||
|
||||
Press Ctrl-c when you'd like to exit or pass `-d` to run in detached mode.
|
||||
|
||||
Visit the running application at [http://localhost:8080](http://localhost:8080).
|
||||
|
||||
## Setting Vars
|
||||
|
||||
Every environment variable for local development is set in [src/docker-compose.yml](../../src/docker-compose.yml).
|
||||
|
||||
Including variables which would be secrets and set via a different mechanism elsewhere.
|
||||
|
||||
## Viewing Logs
|
||||
|
||||
If you run via `docker-compose up`, you'll see the logs in your terminal.
|
||||
|
||||
If you run via `docker-compose up -d`, you can get logs with `docker-compose logs -f`.
|
||||
|
||||
You can change the logging verbosity, if needed. Do a web search for "django log level".
|
||||
|
||||
## Running tests
|
||||
|
||||
tbd.
|
Loading…
Add table
Add a link
Reference in a new issue