Skip to content

Latest commit

 

History

History
12 lines (9 loc) · 1.12 KB

installation.md

File metadata and controls

12 lines (9 loc) · 1.12 KB
Raw

Installation

The project follows the GoodCode.io guide on storing configuration in the environment and the 12factor methodology. Thus, each deployment needs to have its own isolated environment and its own configuration, which shall be stored in the .env file.

Steps

  1. Setup and activate a virtual environment with python3.6. A useful guide on how to do this can be found here.
  2. Install a MySQL client library for your system (sudo apt install default-libmysqlclient-dev for Linux).
  3. Run pip install -e . if in a production environment, or pip install -e .[dev] if in a development environment.
  4. Copy env.sample to .env and edit .env to customize the configuration for your local deployment.
  5. Using MySQL for the database is highly recommended. Create a database and a user and write the credentials to .env in the form of DATABASE_URL=mysql://user:pass@host:port/dbname (omit :port to use the default MySQL port).
  6. Run the migrations manage.py migrate.