Installation instructions

Clone the repository

Using the console, navigate to the root directory in which your projects live and clone this project’s repository:

$ git clone git@github.com:kj-wroclaw/poznaj-backend.git
$ cd poznaj-backend

You may also wish to fork the repository on GitHub and clone the resultant personal fork. This is advised if you are going to be doing development on poznaj-backend and contributing to the project.

There are two ways to install poznaj-backend:

• Stand-alone installation
• Docker-based installation

It is recommended to use docker for local development.

Stand-alone installation

These instructions are specific to Ubuntu Linux but will be similar for other UNIX-based systems.

1. Install PostgreSQL:

$ sudo apt-get update
$ sudo apt-get install postgresql postgresql-contrib

2. Create database and user:

$ su - postgres
$ psql

3. Install virtualenv to be able to create a local environment for your server:

$ pip install virtualenv

4. Create your virtual environment:

$ virtualenv -p /usr/bin/python3 ~/.virtualenvs/poznaj-backend

Make sure that you have python 3 installed as we are using this version.

5. Activate your environment:

$ source ~/.virtualenvs/poznaj-backend/bin/activate

6. Install local and test requirements:

(poznaj-backend) $ pip install -r requirements/local.txt
(poznaj-backend) $ pip install -r requirements/test.txt

7. Install autoenv and put there:

$ cat .env
DATABASE_URL=postgres://poznaj:poznaj@localhost:5432/poznajdb

8. Then run server via:

(poznaj-backend) $ python manage.py migrate
(poznaj-backend) $ python manage.py runserver

9. To run tests use

(poznaj-backend) $ pip install tox
(poznaj-backend) $ tox

Docker-based installation

We are using docker and docker compose to develop code locally. Before you run any commands below please make sure that you have docker installed via this instructions. As you have installed docker install docker-compose

(poznaj-backend)$ pip install docker-compose

After this setup you are ready to go! First run application:

$ make build
$ make run

Then make migrations:

$ make make-migrations

And migrate:

$ make migrate

To create superuser use:

$ docker-compose run django python manage.py createsuperuser

To run test (after you run make run) use:

$ make test