updated readme
This commit is contained in:
parent
0cffd02cdb
commit
6e01befdd1
1 changed files with 21 additions and 0 deletions
21
README.md
Normal file
21
README.md
Normal file
|
@ -0,0 +1,21 @@
|
|||
Django Docker Template
|
||||
=
|
||||
|
||||
Starter template for Django in a Docker container. Includes Postgres for the database and Django Rest Framework configured with Knox token authentication enabled.
|
||||
|
||||
Dependencies
|
||||
=
|
||||
- Docker ([running as non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
|
||||
- Git
|
||||
|
||||
How to use
|
||||
=
|
||||
1. Clone the project and enter the project directory
|
||||
1. `git clone https://edbuildsthings.com/tiradoe/django-docker-template.git`
|
||||
2. `cd django-docker-template`
|
||||
2. Run the setup script
|
||||
1. `./firstRun.sh` and enter information when prompted
|
||||
2. If something goes wrong, running `git checkout .` will restore any changes but you'll need to manually delete the project directory that was created
|
||||
|
||||
That's it! You should now have a basic project running with documentation at `http://localhost:8000`
|
||||
|
Loading…
Add table
Reference in a new issue