4 :Description: A django application for sharing and uploading class notes.
5 :Copyright: FinalsClub, a 501c3 non-profit organization
6 :License: GPLv3 except where otherwise noted
7 :Contact: info@karmanotes.org
9 v3.0 of the karmanotes.org website from the FinalsClub
17 TODO: Explain what problems KarmaNotes is solving
23 TODO: Put docs on [RTFD](https://readthedocs.org/)
28 If you're starting to work on this project and you need it setup on your local
29 machine, follow the steps below.
31 1. Make sure you have installed ``git``, the ``PostgreSQL`` server, client and
32 development files, ``Python`` including the development files, ``Fabric``,
33 ``pip``, ``virtualenv`` and ``virtualenvwrapper``.
35 2. Clone the project from the central repo::
37 git clone git@github.com:FinalsClub/karmaworld.git
39 Note that you have to have your SSH keys setup on GitHub to use this URL. If
40 you don't, you can use the HTTP URL:
41 ``https://github.com/FinalsClub/karmaworld.git``.
43 3. Create a database and optionally a username and put them in the
44 ``DATABASES`` setting in a ``local.py`` file that you'll place in
45 ``karmaworld/settings/``.
47 4. Make sure that you're in the root of the project that you just cloned and
52 This will make a virtualenv, install the development dependencies and create
55 5. Now you can run ``./manage.py runserver`` and visit the site in the browser.
61 * [rdegges](https://github.com/rdegges/django-skel) for the django-skel template