README.md

SciPost

The complete scientific publication portal

Dependencies

SciPost is written in Python 3.5 using Django and requires PostgreSQL 9.4 or higher. Python dependencies are listed in requirements.txt. Frontend dependencies are managed by NPM in package.json.

Getting started

Database

Make sure that Postgres is installed and running, and that a database and user are set up for it. A good guide how to do this can be found here (NOTE: stop before the 'Update settings' part).

Python version

Make sure you're using Python 3.5. If you need to use multiple versions of Python, use pyenv.

Python dependencies

Setup a virtual environment using(py)venv, and activate it:

$ pyvenv scipostenv
$ source scipostenv/bin/activate

Now install dependencies:

(scipostenv) $ pip install -r requirements.txt

Frontend dependencies

NPM (version 4.0 or higher; tested on v4.1.2) will take care of frontend dependencies. To install all packages now run:

(scipostenv) $ npm install

Settings

In this project, most settings are tracked using Git. Some settings however, are still secret are and should stay that way. These settings may be saved into the secrets.json file in the root of the project. The minimum required structure is as follows, please mind the non-empty, but still invalid SECRET_KEY:

{
  "SECRET_KEY": "<key>",
  "DB_NAME": "",
  "DB_USER": "",
  "DB_PWD": ""
}