Getting Started

🚀 Developer Getting Started Guide

This guide outlines the steps required to spin up the project in your local development environment.

📋 Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (version >= 22.0.0)
• Docker & Docker Compose
• Git

🛠️ Step-by-Step Instructions

1. Clone the Repository

   git clone [email protected]:example/project-docs.git
   cd project-docs

2. Install Dependencies

   npm ci

3. Run Development Server Start the local compilation and watch process:

   npm run serve

✅ Environment Readiness Checklist

• Node.js installed and configured
• Local database running via Docker
• Environment variables configured from .env.example
• Local Quartz server accessible at http://localhost:8080

🔍 What’s Next?

• Check out our System Architecture page to understand backend dynamics.
• Read the Deployment Guide before shipping changes to production.

---

Back to Guides.

Tags: setup install getting-started