Setup & Development

This guide explains how to set up the project and start the development server.

• Prerequisites
• Installation
  • Running the project
• Docker
  • Installing Docker
  • Installing Docker Compose
  • Quick run
    • Running the app in Watch Mode (Local Development)
• Upgrade

Prerequisites

Ensure you have the following installed:

• Node.js version >= 20.10.0
• Pnpm version >= 9.5.0

Installation

# Install dependencies from the package.json file.
pnpm install

Note: Don't delete the pnpm-lock.yaml file. It's used to lock the dependencies version.

Running the project

# Start the development server
pnpm start

Docker

Set up your application and database effortlessly using Docker and Docker Compose.

Installing Docker

Get Docker from the official site for your operating system:

• Mac: Install Docker for Mac
• Windows: Install Docker for Windows
• Ubuntu: Install Docker on Ubuntu

Installing Docker Compose

Download Docker Compose from official website.

Quick run

Running the app in Watch Mode (Local Development)

To start the application in watch mode for local development:

1. Open your terminal and navigate to the project directory.
2. Run the command:

docker compose -f docker-compose.local.yml up --build -d

Note: The application will run on port 4200 (http://localhost:4200)

Upgrade

To upgrade the dependencies to the latest version, run:

# Upgrade dependencies to the latest version
pnpm upgrade --interactive --latest