Sloth Board

Documentation

Installation guide, technical stack, and known limitations for Sloth Board.

How to install

Swagger API documentation is available at the following URL: Swagger documentation.

[ 01 ]

Prerequisites

Before you begin, install the following tools on your machine.

Git : Install Git
Docker Desktop : Install Docker Desktop (Windows)

[ 02 ]

Start Docker

Once prerequisites are installed, launch Docker Desktop and wait until the engine is ready.

[ 03 ]

Create a working directory

Create a dedicated project folder, then move into it.

Terminal

mkdir sloth-boardcd sloth-board

[ 04 ]

Clone the repositories

Inside this directory, clone the frontend and backend repositories.

Terminal

git clone https://github.com/NolanLiogier/frontend-web-trainer-activitygit clone https://github.com/NolanLiogier/backend-trainer-activity

[ 05 ]

Get docker-compose.yml

Download the following file, then place it at the root of your working directory.

Download docker-compose.yml

Expected directory layout

After cloning the repositories and placing docker-compose.yml at the root, your working directory should look like this. Only the main folders and key files are shown.

Project structure

sloth-board/
├── .env
├── docker-compose.yml
├── backend-trainer-activity/
│   ├── prisma/
│   ├── src/
│   ├── test/
│   ├── Dockerfile
│   ├── package.json
│   └── .env
└── frontend-web-trainer-activity/
    ├── public/
    ├── src/
    ├── Dockerfile
    ├── nginx.conf
    └── package.json

[ 06 ]

Root .env file

At the root of the directory (next to docker-compose.yml), create a .env file with the following content.

.env

# PostgreSQLPOSTGRES_USER=CHANGE_MEPOSTGRES_PASSWORD=CHANGE_MEPOSTGRES_DB=CHANGE_MEPOSTGRES_PORT=CHANGE_ME# pgAdminPGADMIN_DEFAULT_EMAIL=CHANGE_MEPGADMIN_DEFAULT_PASSWORD=CHANGE_MEPGADMIN_PORT=CHANGE_ME# BackendJWT_SECRET=CHANGE_MEJWT_EXPIRES_IN=CHANGE_ME# FrontendFRONTEND_PORT=CHANGE_ME

[ 07 ]

.env file in backend/

Inside the backend folder, create another .env file with the following content.

backend/.env

DATABASE_URL="CHANGE_ME"JWT_SECRET="CHANGE_ME"JWT_EXPIRES_IN=CHANGE_ME

[ 08 ]

Start the application

From the root of the directory, start all services in the background.

Terminal

docker compose up -d

Technical stack

A self-hostable full stack application: React frontend, NestJS backend with Prisma, and a PostgreSQL database.

Frontend

React
Tailwind CSS

Backend

NestJS
Prisma

Database

PostgreSQL

Known limitations

Content coming soon.