Tech Stack & Setup

This page describes the technology stack and setup instructions for the Gami API.

---

Technology Stack

Component	Technology
Runtime	Node.js (TypeScript)
Framework	Fastify
Database	PostgreSQL
ORM	Prisma
Validation	Zod
Documentation	Swagger / OpenAPI
Containerization	Docker & Docker Compose

---

Prerequisites

• Node.js v18+
• Docker & Docker Compose

---

Environment Variables

Create a .env file in the root directory:

DATABASE_URL="postgresql://user:password@localhost:5432/gamibot?schema=public"

---

Installation

Docker (Recommended)

Start both the API and PostgreSQL database:

docker-compose up -d --build

The API will be available at http://localhost:3000.

Local Development

1. Install Dependencies:

   npm install

2. Run Migrations:

   npx prisma generate
   npx prisma migrate dev

3. Start Server:

   npm run dev

---

Testing

The project uses Vitest for integration testing:

npm test

Test Suites

Suite	Coverage
XP Tests	XP awarded correctly based on quiz scores
Topic Tests	Topic progress calculated accurately
Badge Tests	All badges awarded when conditions are met
Stats Tests	User statistics aggregation and initialization

---

Next Steps

• API Reference - Authentication and endpoints
• Gami API Overview - Features overview