Skip to content
  • Français: Cette page n'est pas encore traduite en français.

Setup your development environment

Requirements

In order to run LabelIt locally on your system, you must install the following softwares:

Local installation has been tested with Docker v20.10

Steps

Clone the repository

Clone LabelIt repository using repository

git clone git@github.com:voicelab-org/labelit.git
cd labelit

All of the following commands must be run from the root of the labelit folder on your local PC

Build or download docker images

Build Docker images locally using:

docker compose build

Launch containers

# For development installation
docker compose up

Note: If you have other containers running on your system, they may clash with the new containers. To avoid conflicts, kill these existing containers with the command: docker kill $(docker ps -q)

You will see the output of each container in the same terminal. Do not close the terminal until you are done as this will shut down labelit.

Initializing database

Execute these commands to initialize your local database. It will also create some users (see Register users)

docker compose exec backend bash -c "python manage.py migrate && python manage.py create_initial_users_if_do_not_exist"

Initializing buckets

To store audio / images, LabelIt uses some S3 buckets. You must create them to be abble to upload a dataset:

docker compose exec minio bash -c "mkdir /export/labelit-audio-bucket /export/labelit-audio-source-bucket /export/uploaded-images"

Access LabelIt 🚀