README.md

Install

These instructions will get you a project up and running on your local machine for development and testing purposes.

Prerequisites

Be sure to have the following properly installed:

• Docker
• Rust v1.70 or higher
• cargo-make v0.36.3 or higher

Setup

Build the client and backend services:

cargo make backend-build && \
cargo make client-build

Launch

💻 Client

To launch the client use the following command:

cargo make client-start

🏢 Backend

To launch the backend use the following command:

cargo make backend-start

Make sure you have your .env file ready with the necessairy variables. See .env.example in crate

💾 Database

There are several tasks available to manipulate the database.

Make sure you have your .env file ready with the necessairy variables. See .env.example in the database folder

Build the database image

cargo make backend-build

Start the database

cargo make backend-start

Query the database. Takes a string query as argument

cargo make backend-query

Stops the database

cargo make backend-stop

Clean the database. Deleting the container and image, with the choice to also delete the database

cargo make backend-clean