Getting Started

Welcome to the documentation. This guide walks you through the fundamentals of setting up and using the project. Whether you are new to the platform or migrating from another tool, you will find step-by-step instructions here.

Prerequisites

Before you begin, make sure you have a supported runtime installed. The project requires Node.js 18 or later. You can check your version by running node --version in a terminal.

Quick start

Clone the repository, install dependencies, and run the development server. The default port is 3000, but you can override it with the PORT environment variable. Once the server is running, open your browser and navigate to http://localhost:3000.

Next steps

After completing the quick start, explore the Installation and Configuration sections in the sidebar. The API Reference documents every endpoint and option, and the Examples section provides working code samples for common use cases.