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.

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

Add an install file #7

Merged
merged 1 commit into from Aug 29, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 57 additions & 0 deletions INSTALL.rst
@@ -0,0 +1,57 @@
============
INSTALLATION
============

You've got two projects.

- One is the service API that will store the data;
- One is the Web application to manage and look at your data.

Deploying the service
=====================

Requirements
------------

The service API is built on top of Django and Django REST Framework.

You will need a PostgreSQL server for the database layer.

#. Create a virtualenv using Python 2.7::

virtualenv --python /usr/bin/python2.7 venv

#. Upgrade pip::

./venv/bin/pip install -U pip

#. Install requirements::

./venv/bin/pip install -r 723e_server/requirement.txt

#. Copy the settings.py.example and configure your application::

cp 723e_server/settings.py.example 723e_server/settings.py

#. `Generate a new SECRET_KEY <http://www.miniwebtool.com/django-secret-key-generator/>`_
#. Set ``DEBUG=False`` if production
#. Run Django Auth migration: ``python manage.py migrate auth``
#. Run Django 723e migration: ``python manage.py migrate`
#. Then run the server: ``python manage.py runserver``


Running the client
==================

In order to run the client, you just need to install the dependencies::

npm install
bower install

Then build the CSS files::

grunt less

Then serve the cient::

grunt server