getting-started.md

layout	title	nav_order
default	Getting started	2

Getting started

{: .no_toc }

Table of contents

{: .no_toc .text-delta }

1. TOC {:toc}

{: .important } For development deployment, the use of Docker is recommended.

Clone repo

You can start your fantastic development with {% include uvlhub.html %} by cloning our official repository.

git clone https://github.com/diverso-lab/uvlhub.git
cd uvlhub

Environment variables

To create an .env file according to a basic template, run:

cp .env.docker.example .env

Deploy in develop

To deploy the software under development environment, run:

docker compose -f docker/docker-compose.dev.yml up -d 

This will apply the migrations to the database and run the Flask application.

{: .highlight } If everything worked correctly, you should see the deployed version of {% include uvlhub.html %} in development at http://localhost