Quickstart¶
To get a quick development environment follow these steps:
Install poetry, Docker, and docker-compose (usually docker-compose is already included by Docker).
Clone a local copy of Quetzal:
git clone git@github.com:quetz-al/quetzal.git
Create a virtual environment and install Quetzal:
cd quetzal poetry install
For an environment based on docker-compose, build the Docker images:
docker-compose build
At this point you can get a local Quetzal server that saves files in a local filesystem. Launch it with:
docker-compose up
For a server that runs outside the docker-compose environment (for development or testing purposes), modify the
config.py
file according to your needs (in particular the hostnames to the database or the rabbit queue) and launch a server with:FLASK_ENV=local-tests flask run --host 0.0.0.0 --port 5000
Cloud storage¶
Take the development environment to the next step by using cloud storage to store data… (description on how to do this coming soon).