Installation from the sources

This guide will explain how to setup Prophecies using the sources.

Prerequisites

This section describes how to install Prophecies for development. This environment disables many security settings provided by Django and isn't meant to be used for internet-facing instances. For that purpose please follow the installation guide with Docker.

• Python 3.9

• Node 16.x

• Poetry >= 1.2

• Yarn 1.x

• Git

Setup steps

Checkout the repository with git:

git clone [e-mail]:ICIJ/prophecies.git
cd prophecies/

After entering the directory, setup a virtualenv with poetry and to install required packages:

make install

To setup the database (using SQLite3 by default):

make migrate

To create a superuser:

make createsuperuser

For more customization, this app utilizes 12factor inspired environment variables to configure your Django application. You can create .env file using the custom settings variables:

DEBUG=on
DATABASE_URL=
CACHE_URL=dummycache://
STATIC_URL=/static/
SOCIAL_AUTH_PROVIDER_KEY=
SOCIAL_AUTH_PROVIDER_SECRET=
SOCIAL_AUTH_PROVIDER_HOSTNAME=http://localhost:3001
SOCIAL_AUTH_PROVIDER_USERNAME_FIELD=uid
SOCIAL_AUTH_PROVIDER_GROUPS_FIELD=groups_by_applications.prophecies
SOCIAL_AUTH_PROVIDER_STAFF_GROUP=icijstaff

The application can be configured with many environment variables.