Skip to content

Development

Quick Start

Clone the repository:

git clone https://github.com/unipoll/api.git

Or using GitHub CLI:

gh repo clone unipoll/api

Create a virtual environment:

$ pip install virtualenv
$ python -m venv venv

Activate the virtual environment with

$ source venv/bin/activate

Install dependencies:

$ pip install -r test-requirements.txt

Run the app:

You can use the main.py script to run the app.

$ python -b main.py run --reload --port 8000

Install editable package:

Alternatively, you can install the package in editable mode. Editable mode allows you to make changes to the source code and see the changes reflected immediately.

$ pip install -e .
$ unipoll-api run --reload --port 8000