Futsal App

Application for DUMP futsal tournament

Tech Stack

Backend (API):

• NestJS - Backend framework
• Prisma - ORM for database
• PostgreSQL - Relational database

Frontend (Web):

• React - Frontend framework
• SCSS - CSS preprocessor

Monorepo Management:

• Turborepo - High-performance build system for monorepos
• Yarn - Package management

Prerequisites

Before running the project, make sure you have the following installed:

• Node.js (v20 recommended)
• Yarn (v3.6.4 or higher)
• Docker and Docker Compose

Project Structure

futsal-app/
├── apps/
│   ├── api/          # NestJS backend
│   ├── admin/        # Admin React frontend (served at /admin)
│   └── app/          # Public React frontend (served at /)
├── packages/
│   └── types/        # Shared TypeScript types
├── infrastructure/   # Project infrastructure
├── compose.yml       # Docker compose file
├── turbo.json        # Turborepo configuration

Installation

1. Clone the repository:

   git clone https://github.com/dump-hr/futsal-app.git
   cd futsal-app

2. Install dependencies:

   yarn install

3. Set up environment variables:

   Create a .env file in the apps/api directory with the following content:

   DATABASE_URL="postgresql://dumpovac:dump1234@localhost:3001/futsal-db?schema=public"

How to Run

1. Start the Database

Start the PostgreSQL database using Docker Compose in the root directory:

docker compose up -d

This will start a PostgreSQL 15 container with:

• Database: futsal-db
• User: dumpovac
• Password: dump1234
• Port: 3001 (mapped to 5432 inside the container)

2. Apply Database Migrations

Generate the Prisma client and apply migrations:

# Generate Prisma client
yarn db:generate

# Apply database migrations
yarn db:migrate

3. Start the Development Servers

Run the API and both frontend applications in development mode:

yarn dev

This will start:

• API at http://localhost:3000 (default NestJS port)
• Web at http://localhost:5173 (default Vite port)
• App at http://localhost:5174

Running Individual Apps

To run only the API:

yarn workspace api run dev

To run only the Admin app:

yarn workspace admin run dev

To run only the App:

yarn workspace app run dev

Database Migrations

Available Commands

Command	Description
yarn db:generate	Generate Prisma client from schema
yarn db:migrate	Create and apply new migrations
yarn db:studio	Open Prisma Studio (database GUI)
yarn db:seed	Seed the database with initial data
yarn prisma	Run Prisma CLI commands

Creating a New Migration

1. Modify the Prisma schema in apps/api/prisma/schema.prisma
2. Run the migration command:

   yarn db:migrate

3. Enter a name for your migration when prompted

Shared Types

The project uses a shared types package (@futsal-app/types) located in packages/types/ that contains DTOs and enums used by the API, Admin, and App applications.

Adding a New Shared Type

1. Create or modify type files in packages/types/src/:

   packages/types/src/
   ├── index.ts          # Main export file
   ├── enum.ts           # Shared enums
   └── dto/
       └── tournament.ts # DTO definitions
   

2. Export the new type from packages/types/src/index.ts:

   export * from './dto/tournament';
   export * from './dto/your-new-dto'; // Add your new export
   export * from './enum';

3. Build the types package:

   yarn workspace @futsal-app/types run build

4. Use the types in your API or Web app:

   import { TournamentDto, Group } from '@futsal-app/types';