README.rst

Notejam: Django

Notejam application implemented using Django framework.

Python version: Latest 2.7

Django version: 1.6 (see requirements.txt)

Installation and launching

Clone

Clone the repo:

$ git clone [email protected]:komarserjio/notejam.git YOUR_PROJECT_DIR/

Install

Use virtualenv or virtualenvwrapper for environment management.

Install dependencies:

$ cd YOUR_PROJECT_DIR/django/
$ pip install -r requirements.txt

Create database schema

$ cd YOUR_PROJECT_DIR/django/notejam/
# The superuser creation will happen during the syncdb management command below
$ ./manage.py syncdb
$ ./manage.py migrate

Launch

Start django web server:

$ cd YOUR_PROJECT_DIR/django/notejam/
$ ./manage.py runserver 0.0.0.0:8000

Go to http://127.0.0.1:8000/ in your browser.

Run tests

Run functional and unit tests:

$ cd YOUR_PROJECT_DIR/django/notejam/
$ ./manage.py test

Contribution

Do you have python/django experience? Help the app to follow python and django best practices.

Please send your pull requests in the master branch. Always prepend your commits with framework name:

Django: Implemented sign in functionality

Read contribution guide for details.