Development
Learn how to set up and develop the project locally
Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (v18 or higher)
- pnpm (v8 or higher)
- PostgreSQL
Getting Started
1. Clone the repository
1. Clone the repository
2. Install dependencies
2. Install dependencies
3. Database Setup
3. Database Setup
- Create a PostgreSQL database
- Copy
.env.example
to.env
- Update database connection details in
.env
Run migrations and seed the database:
4. Start Development Server
4. Start Development Server
The application will be available at http://localhost:1111
Available Scripts
Database Commands
Database Commands
Development Commands
Development Commands
Development Tips
The development server runs on port 1111 by default. You can modify this in the package.json
scripts.
Running db-reset
or migrate-dev-reset
will clear all data in your database. Use with caution!