Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

Commit dcd0b945 authored by Jon Yu's avatar Jon Yu
Browse files

Add basic usage notes, remove debugging flag

parent 3a68b246
# Umich Django Project Template
The following project provides a template for creating a Django application with University of Michigan styling and branding.
See the [ITS style guide](https://its.umich.edu/web-strategy/seamless-experience/visual-design/style-guide/its.umich) for additional details.
## Starting a base Django project with the Umich template
### Option 1 - Using the helper script
#### Requirement: Docker
Run `start_project.sh` with the following arguments in order:
- Absolute path to where you want your templated project to be created; must be an empty dir
- Name of the project
e.g. `./start_project.sh ~/Desktop/my_new_project my_new_project`
### Option 2 - Using django-admin
#### Requirement: Django installed in current environment
Run `django-admin startproject --template ./app [output_dir] [project_name]`
## Modifying and running the current project with a SQLite db
```bash
$ docker-compose build
$ docker-compose up
```
\ No newline at end of file
#!/usr/bin/env bash
set -exE
set -eE
readonly IMAGE_TAG=umich_django_template
readonly CONTAINER_NAME=$IMAGE_TAG
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment