Environment Setup

These instructions are written for a typical linux system, and not verified to work on Windows or MacOS.

Requirements

To develop Convinator, there are some software requirements you need to have installed:

• docker
  • Runs the database and other services in containers
• rust
  • Primary backend language
• node
  • Runtime for the frontend
• pnpm
  • Package manager for frontend dependencies
• just
  • Command runner for project scripts
• tmux
  • Terminal multiplexer for running multiple apps at once

Setup

0. Clone the repository and change to its directory

   git clone ssh://git@codeberg.org/borisnl/Convinator.git convinator && \
   cd convinator
   

1. Install the pnpm and cargo dependencies using just

   just install
   

2. Copy the .env.example file to .env and set the CONVI_JWT_SECRET to a random string

   cp .env.example .env && \
   sed -i "s/^CONVI_JWT_SECRET=.*$/CONVI_JWT_SECRET=$(openssl rand -hex 32)/g" .env
   

3. Run the front- and backend in tmux using just

   just run
   

   The logs for the backend will be shown in the left tmux pane, and the frontend in the right pane.

4. (OPTIONAL) If you’d like to use the S3 adapter, you need to set up garage (a local S3 service). This command should also update your .env file with the generated secrets.

   just setup-garage
   

You should now be able to reach the frontend at localhost:4200 and start making changes. Changes in the frontend will automatically reload, but the backend will not. You will have to manually restart it using just run-backend in the backend tmux session (the left pane).

To stop the development server, you can run just kill. This command will kill the tmux session and stop the running docker containers.