https://github.com/vaibhav-jain/skeleton
A simple Django starter template
https://github.com/vaibhav-jain/skeleton
cookiecutter django django-starter-template skeleton
Last synced: 3 months ago
JSON representation
A simple Django starter template
- Host: GitHub
- URL: https://github.com/vaibhav-jain/skeleton
- Owner: vaibhav-jain
- License: apache-2.0
- Created: 2016-02-07T14:29:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-25T23:40:35.000Z (about 1 year ago)
- Last Synced: 2024-10-11T22:08:19.524Z (9 months ago)
- Topics: cookiecutter, django, django-starter-template, skeleton
- Language: Python
- Homepage:
- Size: 109 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/vaibhav-jain/skeleton)
# skeleton
A simple Django starter template
## Setup Instructions ##
1. Make sure you have Django-1.9 installed on your system
2. Create your new Django project by running this command
`django-admin.py startproject mynewproject --template=https://github.com/kaizentech/skeleton/archive/master.zip`
3. Install requirements by running this command from your project dir
On Prod:
`pip install -r requirements.txt`
On Dev:
`pip install -r requirements/dev.txt`
4. Setup these environment variables on your system (or in virtualenv)
On Windows
```
set "DEBUG=True"
set "DJANGO_SETTINGS_MODULE=config.settings.dev"
set "SECRET_KEY=xxxxxYourxxSecretxxKeyxxxxx"
set "DATABASE_URL=psql://username:[email protected]:5432/dbname"
```
On Linux
```
export DEBUG='TRUE'
export DJANGO_SETTINGS_MODULE='config.settings.dev'
export SECRET_KEY='xxxxxYourxxSecretxxKeyxxxxx'
export DATABASE_URL='psql://username:[email protected]:5432/dbname'
```
You can also save these in your virtualenv's script for auto invocation during virtualenv initialization
5. Apply Migrations by running this command from the project dir
`python manage.py migrate`
6. Create Super User
`python manage.py createsuperuser`
6. Finally run your dev server by running this command from your project dir
`python manage.py runserver`
# Goodies Included #
1. Seprate settings for development and production environment
2. Settings based on [django-environ](https://django-environ.readthedocs.org/en/latest/)
3. Excellent admin interface by [django-grappelli](https://django-grappelli.readthedocs.org/en/latest/index.html)
4. Static file serving with [whitenoise](https://github.com/evansd/whitenoise)
5. Extra commands by [django-extensions](https://github.com/django-extensions/django-extensions)
### Help ###
1. Use this to generate [SECRET_KEY](http://www.miniwebtool.com/django-secret-key-generator/)