Description: | A django application for sharing and uploading class notes. |
---|---|
Copyright: | FinalsClub, a 501c3 non-profit organization |
License: | GPLv3 except where otherwise noted |
Contact: | info@karmanotes.org |
v3.0 of the karmanotes.org website from the FinalsClub Foundation
KarmaNotes is an online database of college lecture notes. KarmaNotes empowers college students to participate in the free exchange of knowledge.
TODO: see ./docs/ TODO: Put docs on [RTFD](https://readthedocs.org/)
If you're starting to work on this project and you need it setup on your local machine, follow the steps below.
Make sure you have installed
git
, thePostgreSQL
server, client and development files,Python
including the development files,Fabric
,pip
,virtualenv
andvirtualenvwrapper
.Clone the project from the central repo:
git clone git@github.com:FinalsClub/karmaworld.git
Note that you have to have your SSH keys setup on GitHub to use this URL. If
you don't, you can use the HTTP URL:
https://github.com/FinalsClub/karmaworld.git
.
Create a database and optionally a username and put them in the
DATABASES
setting in alocal.py
file that you'll place inkarmaworld/settings/
.Make sure that you're in the root of the project that you just cloned and run
fab here first_deploy
This will make a virtualenv, install the development dependencies and create the database tables.
- Now you can run
./manage.py runserver
and visit the site in the browser.
- KarmaNotes.org is a project of the FinalsClub Foundation with generous funding from the William and Flora Hewlett Foundation
- Also thanks to [rdegges](https://github.com/rdegges/django-skel) for the django-skel template