Getting started

Table of contents

  1. Clone repo
  2. Environment variables
  3. Deploy in develop

For development deployment, the use of Docker is recommended.

Clone repo

Are you a student of Configuration Evolution and Management (EGC)?

The course works on its own copy of the project, github.com/EGCETSII/uvlhub, which you fork as uvlhub_practicas. Clone your fork, not the repository below: the two have diverged and the practicals are written against the course copy.

git clone https://github.com/<YOUR_GITHUB_USER>/uvlhub_practicas.git
cd uvlhub_practicas

You can start your fantastic development with uvlhub 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, seed it with test data the first time it comes up empty, and run the Flask application.

If everything worked correctly, you should see the deployed version of uvlhub in development at http://localhost