README.md

   1 ==========
   2 KarmaWorld
   3 ==========
   4 __Description__: A django application for sharing and uploading class notes.
   5
   6 __Copyright__: FinalsClub, a 501c3 non-profit organization
   7
   8 __License__: GPLv3 except where otherwise noted
   9
  10 __Contact__: info@karmanotes.org
  11
  12 v3.0 of the karmanotes.org website from the FinalsClub Foundation
  13
  14
  15
  16
  17 Purpose
  18 =======
  19
  20 KarmaNotes is an online database of college lecture notes.  KarmaNotes empowers college students to participate in the free exchange of knowledge.
  21
  22 Docs
  23 ====
  24
  25 TODO: see `./docs/`
  26 TODO: Put docs on [RTFD](https://readthedocs.org/)
  27
  28
  29 Install
  30 =======
  31 If you're starting to work on this project and you need it setup on your local
  32 machine, follow the steps below.
  33
  34 1. Make sure you have installed ``git``, the ``PostgreSQL`` server, client and
  35    development files, ``Python`` including the development files, ``Fabric``,
  36    ``pip``, ``virtualenv`` and ``virtualenvwrapper``.
  37
  38 2. Clone the project from the central repo::
  39
  40         git clone git@github.com:FinalsClub/karmaworld.git
  41
  42 Note that you have to have your SSH keys setup on GitHub to use this URL. If
  43 you don't, you can use the HTTP URL:
  44 ``https://github.com/FinalsClub/karmaworld.git``.
  45
  46 3. Create a database and optionally a username and put them in the
  47    ``DATABASES`` setting in a ``local.py`` file that you'll place in
  48    ``karmaworld/settings/``.
  49
  50 4. Make sure that you're in the root of the project that you just cloned and
  51    run
  52
  53         fab here first_deploy
  54
  55 This will make a virtualenv, install the development dependencies and create
  56 the database tables.
  57
  58 5. Now you can run ``./manage.py runserver`` and visit the site in the browser.
  59
  60 Thanks
  61 ======
  62
  63 * KarmaNotes.org is a project of the FinalsClub Foundation with generous funding from the William and Flora Hewlett Foundation
  64
  65 * Also thanks to [rdegges](https://github.com/rdegges/django-skel) for the django-skel template