Not actively maintained anymore. Will still use but will require updates, etc.

A framework for a new Django 1.7/python 2.7 project utilizing vagrant or docker 1.5.0 for setting up the development environment.

• Make sure you have an environment variable set up on your host machine which sets DJANGO_ENV to development.
• Create an .env file with the following contents (Update the port, username and password in accordance with your local database setup)

#DJANGO
DJANGO_SECRET_KEY=None
#MYSQL
MYSQL_DATABASE=django_starter_development
MYSQL_USER=root
MYSQL_PASS=root
MYSQL_HOSTNAME=127.0.0.1
MYSQL_PORT=8889

• Set up virtualenv and do all python related tasks within your virtualenv.

First read: https://gist.github.com/chiedojohn/e7ece910ef4a7e3ce125

You will need to set up a file by the name of .env in the root of your project to store private environments that should not be committed to the git repository. It should have the following contents that you can customize if needed.

#DJANGO
DJANGO_ENV=development
DJANGO_SECRET_KEY=None
#MYSQL
MYSQL_DATABASE=app_development
MYSQL_USER=admin
MYSQL_PASS=admin
# This is using the docker link
MYSQL_HOSTNAME=db
MYSQL_PORT=3306

First read: https://gist.github.com/chiedojohn/c3e37041b829f28c0c78

• To start your django project, run the following in your container or vm after creating your database.

python manage.py migrate
python manage.py createsuperuser

###Notes: Run the server by running the following:

python manage.py runserver 0.0.0.0:8000

You will want to have the following command running in a window on your local machine to handle sass compilation, js compilitation, etc.

gulp

The code should be commented pretty thouroughly. If anything is unclear, please let me know. These are not perfect tests nor are they exhaustive. You will want to write beter tests than these that covers more test cases. This is a great start though, and the other test cases should be trivial.

• To run tests individually, you can just run the following python manage.py test app_name

• Models
  • apps/people/tests/test_person_model.py
• Views
  • apps/home/tests/test_views.py
  • app/people/tests/test_people_api.py
• Misc classes
  • apps/people/tests/test_example_class.py
• Stubs (pretend)
  • apps/people/tests/test_example_class.py
• Mocks (mock)
  • apps/people/tests/test_example_class.py

• Expects - https://github.com/jaimegildesagredo/expects
• Nosetests - https://nose.readthedocs.org/en/latest/
• Django-nose - https://github.com/django-nose/django-nose