Getting Started

This guide walks you through setting up the project locally for development.

Prerequisites

Tool	Version	Install

Clone the repository

git clone https://github.com/your-org/your-repo.git
cd your-repo

Activate the commit-msg hook (one-time, after cloning)
```
git config core.hooksPath .githooks
```
Copy the environment file
```
cp .env.example .env
```
Open .env and fill in the required values. See Environment Variables below.

Install dependencies

# Replace with your package manager / build tool
# e.g. npm install / pip install -r requirements.txt / go mod download / mvn install

Start the development server

# Replace with your start command
# e.g. npm run dev / python manage.py runserver / go run ./cmd/server

Variable	Required	Default	Description
`PORT`	No	`3000`	Port the server listens on

# Start development server
# Run tests
# Run linter
# Build for production

Port already in use

Find and stop the process occupying the port before starting the server.

Dependencies not installing

Make sure your runtime version matches the one listed in Prerequisites. Delete any lock files and retry a fresh install.

For other issues, check the FAQ or open a Discussion.