Quickstart
This guide will help you set up your development environment and get the application running in minutes.
Prerequisites
Before you begin, ensure you have the following installed on your UNIX-based system (Linux or macOS):
- Node.js: v24.x or higher (use fnm or nvm for version management)
- pnpm: v10.26.2. How to install .
- Docker: Required for the local database and services. How to install .
Lynx is designed for UNIX systems. Windows users are recommended to use WSL2.
Installation
-
Clone the repository:
-
Install dependencies:
Setup
-
Start Backend Services: Link spins up a local PostgreSQL instance using Docker. Run the following command to start the backend services:
Keep this terminal window open or run it in the background.
-
Run Early Setup: This script handles git configurations, database migrations, and seeding:
After this step you may end the backend services process.
Running the App
Once setup is complete, you can start the development server:
Open http://lynx.localhost in your browser to see the application.
The custom localhost domain will only work if you run the app using pnpm dev, which also runs Caddy as a reverse proxy. Alternatively, if running:
you can access the app at http://localhost:3000 .
Next Steps
Now that you’re up and running, explore the following resources:
- Tech Stack: Learn about the technologies powering Lynx.
- Scripts: Learn about the available scripts for development and maintenance.
- Modules: Discover the core features and modules.