zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-08-05 09:21:54 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update and organize documentation

Browse source
This commit is contained in:
Seamus Johnston 2022-08-31 15:39:44 -05:00
parent d88fa8fb3e
commit 2386258159
No known key found for this signature in database
GPG key ID: 2F21225985069105
8 changed files with 98 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

22
src/README.md
View file

@ -1,22 +1,6 @@
# Registrar
# Registrar source code
========================
## Development
[Developer documentation](../docs/developer/README.md) is in [docs/developer](../docs/developer/).
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`
### Update Dependencies
1. Check the [Pipfile](./src/Pipfile) for pinned dependencies and manually adjust the version numbers
1. Run `cd src`, `docker-compose up`, and `docker-compose exec app pipenv update` to perform the upgrade and generate a new [Pipfile.lock](./src/Pipfile.lock)
[Operations documentation](../docs/operations/README.md) is in [docs/operations](../docs/operations/).