Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

delete picture, add info #275

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

delete picture, add info #275

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
.. image:: https://drive.google.com/uc?id=0B58q9z1XmLXIUDdDMXpoZFEyZDQ
:target: https://scholarium.at/

.. image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg
:target: https://github.com/pydanny/cookiecutter-django/
:alt: Built with Cookiecutter Django
Expand All @@ -11,14 +8,25 @@
.. image:: https://coveralls.io/repos/github/valuehack/scholariumat/badge.svg?branch=master
:target: https://coveralls.io/github/valuehack/scholariumat?branch=master

Setup
Setup for MAC OS/Linux
-----
* This project runs on Python >= 3.6 (and Django >= 2.0)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's important that it's python3.6

* Requirements for local virtual environments can be found in requirement/local.txt. Install with ``pip install -r requirements/local.txt``
* Create an virtual environment
* Install venv ``python3 -m pip install --user virtualenv``
* Create venv ``python3 -m venv .venv``
* Activate venv ``source .venv/bin/activate``
* Example: ``.venv/bin/pip install -r requirements``
* Install Requirenments pip install -r requirements.txt``
* Install Cairo and Pago ``brew install cairo`, ``brew install pago``
* Install Django Debugger Toolbar pip install django-debug-toolbar``
* API/Secret keys are managed as environmental variables. There a no required variables but some functionality depends on certain keys. A list variables needed for production can be found in ``app.json``.
* Create accessible postgres database with same name (or at location specified in the ``DATABASE_URL`` environmental variable) and run ``python manage.py migrate``
* Default settings for local runs are ``config/settings/local.py``. Tests (including Travis) use ``config/settings/test.py`` and production environments use ``config/settings/production.py``.

Database Setup
------
* Create a database dump on your server ``pg_dump dbname > outfile``
* Restore dump ``psql dbname < infile``
* Create accessible postgres database with same name (or at location specified in the ``DATABASE_URL`` environmental variable) and run ``python manage.py migrate``

Running Tests
-------------
Tests are handled by django: ``python manage.py test``
Expand Down