<commit_before>==========
KarmaWorld
==========
:Description: A django application for sharing and uploading class notes.
:Copyright: FinalsClub, a 501c3 non-profit organization
:License: GPLv3 except where otherwise noted
:Contact: <EMAIL>

v3.0 of the karmanotes.org website from the FinalsClub 




Purpose
=======

TODO: Explain what problems KarmaNotes is solving

Docs
====

TODO: see `./docs/`
TODO: Put docs on [RTFD](https://readthedocs.org/)


Install
=======


Thanks
======

* TODO: Add funders
* [rdegges](https://github.com/rdegges/django-skel) for the django-skel template
<commit_msg>Added Install instructions to the README.<commit_after>==========
KarmaWorld
==========
:Description: A django application for sharing and uploading class notes.
:Copyright: FinalsClub, a 501c3 non-profit organization
:License: GPLv3 except where otherwise noted
:Contact: <EMAIL>

v3.0 of the karmanotes.org website from the FinalsClub 




Purpose
=======

TODO: Explain what problems KarmaNotes is solving

Docs
====

TODO: see `./docs/`
TODO: Put docs on [RTFD](https://readthedocs.org/)


Install
=======
If you're starting to work on this project and you need it setup on your local
machine, follow the steps below.

1. Make sure you have installed ``git``, the ``PostgreSQL`` server, client and
   development files, ``Python`` including the development files, ``Fabric``,
   ``pip``, ``virtualenv`` and ``virtualenvwrapper``.

2. Clone the project from the central repo::

        git clone <EMAIL>.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``.

3. Create a database and optionally a username and put them in the
   ``DATABASES`` setting in a ``local.py`` file that you'll place in
   ``karmaworld/settings/``.

4. 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.

5. Now you can run ``./manage.py runserver`` and visit the site in the browser.

Thanks
======

* TODO: Add funders
* [rdegges](https://github.com/rdegges/django-skel) for the django-skel template

{'fraction_non_alphanumeric': 0.1252737625930793, 'fraction_numerical': 0.008322382829610162, 'mean_word_length': 4.3489461358313815, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 6, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5465449', 'n_tokens_mistral': 740, 'n_tokens_neox': 675, 'n_words': 281}