diff --git a/README.md b/README.md new file mode 100644 index 0000000..21f8221 --- /dev/null +++ b/README.md @@ -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` + diff --git a/firstRun.sh b/firstRun.sh index 599d81f..34db346 100755 --- a/firstRun.sh +++ b/firstRun.sh @@ -56,3 +56,5 @@ echo "===== CREATING SUPERUSER =====" docker exec -ti "${PROJECT_NAME}-api" ./manage.py createsuperuser echo "Success! Go to http://localhost:8000 to see API documentation." + +git remote remove origin