From 6e01befdd11cb1ea22fd915d70f3d15f571f4203 Mon Sep 17 00:00:00 2001 From: Edward Tirado Jr Date: Sun, 30 Mar 2025 17:13:18 -0500 Subject: [PATCH] updated readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md 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` +