Setup Guide
Follow these steps to get the application up and running on your local machine.
1. Prerequisites
- Node.js ≥ 18.x
- Git
- Docker (optional, for containerized setup)
2. Clone the Repository
git clone https://github.com/example/project.git
cd project3. Install Dependencies
npm install4. Environment Configuration
Create a .env file based on the template:
cp .env.example .env
# Edit .env with your credentials5. Run the Application
For development:
npm run devOr, using Docker:
docker compose up --build6. Verify Installation
Open your browser and navigate to http://localhost:3000. You should see the welcome page.