zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-08-06 01:35:22 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Seamus Johnston 2022-08-10 10:57:22 -05:00
parent 4474912758
commit d810eee37c
No known key found for this signature in database
GPG key ID: 2F21225985069105
2 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -7,6 +7,10 @@ Welcome to .gov! This is a repository to house work on the current .gov site(s).
TBD
## Code
Code is located in the [src](./src/) directory.
## Documentation
### Architectural Decision Records

21
src/README.md Normal file
View file

@ -0,0 +1,21 @@
# Registrar
========================
## 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
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 `docker-compose up` and `docker-compose exec app pipenv update` to perform the upgrade and generate a new [Pipfile.lock](./src/Pipfile.lock)