https://github.com/ccnmtl/ctldjango
Django project template
https://github.com/ccnmtl/ctldjango
Last synced: about 1 year ago
JSON representation
Django project template
- Host: GitHub
- URL: https://github.com/ccnmtl/ctldjango
- Owner: ccnmtl
- License: gpl-3.0
- Created: 2018-09-13T13:16:33.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T18:24:36.000Z (about 1 year ago)
- Last Synced: 2025-04-11T19:40:45.414Z (about 1 year ago)
- Language: HTML
- Size: 2.76 MB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`ctldjango` is a standard Django project template tuned to
implement CTL specific functionality and configuration. This
template includes many dependencies and configurations that aren't
necessary for most django projects. It's intended to be used as a
reference, more than a starting point. When setting up a new
application, it's important to think carefully about exactly what
you want to use, and what you don't.
## What's Included
[](https://greenkeeper.io/)
* Default to Python3
* [django-cas-ng](https://github.com/django-cas-ng/django-cas-ng)
configured for Columbia's central auth service -
http://www.jasig.org/cas/deployments/columbia-university
Anyone with a Columbia UNI by default will have an account.
* virtualenv and pip setup
* a nice Makefile for common build, test, and run tasks
* settings split for dev/prod/staging
* gunicorn configuration
* media dirs for dev/prod/staging configured
* `/stats/` page wired up to display basic traffic stats for the app
* 'main' app with templated index view wired up and ready to go
* jQuery included
* base templates included
* database defaulted to postgresql
* timezone set
* `flake8` (http://pypi.python.org/pypi/flake8), `bandit` (https://pypi.org/project/bandit/) and `eslint` (https://eslint.org/) installed and configured for code linting
* layout based on twitter bootstrap4
* Google Analytics ready to go
* See [ctlsettings](https://github.com/ccnmtl/ctlsettings) for more information on CTL settings setup.
## How to use
### Generate the project
```bash
$ django-admin.py startproject \
--template=https://github.com/ccnmtl/ctldjango/archive/main.zip \
--name=Dockerfile,Makefile,package.json,stats.html \
--extension=py,yml \
project_name
```
Note: On MacOS, sometimes an SSL error will occur when attempting to download the master.zip in this way. To get around this, download a copy of the ctldjango master.zip to your desktop, then execute:
```bash
$ django-admin.py startproject \
--template=~/Desktop/ctldjango-main.zip \
--name=Dockerfile,Makefile,package.json,stats.html \
--extension=py,yml \
project_name
```
`project_name` should be a python module name (ie, lowercase,
no punctuation, etc). It will create a directory called
`project_name` that has a django project in it.
### Setup hidden files
* `mv travis.yml .travis.yml` to activate Travis CI integration
* `mv gitignore .gitignore` to configure git ignore
* `mv eslintrc.js .eslintrc.js` to configure eslint
* `mv bandit .bandit` to configure bandit security linting
### Misc
* Clear the README.md and add a bit about your project.
* Update the `Project Name` string in `base.html` with your application's display name.
### Check it in
* Check the project into version control now.
### Build
We use containment for django, with virtualenv:
$ make
That will create a `ve` directory which contains a virtualenv and has
had all the libraries specified in the `requirements.txt` file
installed into it (this includes django itself). The `ve` directory
should never be checked in. If you need
other libraries for your application, update `requirements.txt` then re-run `make`.
Keep in mind that with virtualenv, there's no need to `activate` an
environment. Instead, a ve has a `bin` directory which contains a
python executable. If you use that instead of the system python
executable, it uses the libraries in that virtualenv.
ctldjango assumes that your project will use a postgresql database
with the same name as your project. So, for our example, you would
then do:
$ createdb myprojectname
and it is all set to use it:
$ make migrate
will install the tables that django needs for it's common apps (sites,
sessions, admin, flatpages, etc).
Tests should pass out of the box:
$ make test
They can be run via Jenkins as well and generate the right reports in
a `reports` directory (which you will want to gitignore).
$ make jenkins
Your application is ready to run now:
$ make runserver
will start a server on `http://localhost:8000/`. The admin app should
be accessible (via a user account created with
`manage.py createsuperuser`)
So go ahead and login to `http://localhost:8000/admin/`
Even without any application specific code, `flatpages` is included so
you can put content on the web right away.
From this point out, it's basic django development. You'll probably
want to do a `./manage.py startapp` to create your own application
within the project and so on.
### AWS CodeBuild CD/CI Template files - Optional
There are two files `buildspec.yml` and `buildspec-staging.yml` within this repository. This is an optional setup if you want to use AWS CodeBuild for deploying into the ECS stack.
The `buildspec.yml` deploys to the production cluster and the `buildspec-staging.yml` builds into the staging cluster.
More detail information on setting up the AWS ECS and AWS CodeBuild is within our Wiki documentation in the Runbook .