Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Environment Setup

  1. Clone the repository

    git clone ssh://git@codeberg.org/borisnl/Convinator.git convinator && \
    cd convinator
    
  2. Install dependencies using pnpm

    pnpm install --frozen-lockfile
    
  3. 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
    
  4. Start the development containers:

    docker compose up -d
    
  5. Setup garage (local S3 service). This command should also update your .env file with the generated secrets.

    ./scripts/setup-garage.sh
    
  6. Run the backend using cargo

    cargo run
    
  7. Run the frontend (in a new terminal)

    cd packages/convi-web && pnpm start
    

You should now be able to reach the frontend at localhost:4200 and start making changes!