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

git clone https://github.com/blinko-space/blinko
cd blinko

2. Install dependencies

pnpm install

3. Database Setup

• Create a PostgreSQL database
• Copy .env.example to .env
• Update database connection details in .env

Run migrations and seed the database:

pnpm migrate-dev

4. Start Development Server

pnpm dev

The application will be available at http://localhost:1111

Available Scripts

Database Commands

pnpm generate          # Generate Prisma client
pnpm prisma-studio     # Open Prisma Studio
pnpm migrate           # Deploy migrations
pnpm migrate-dev       # Create and apply migrations
pnpm db-seed          # Seed the database
pnpm db-reset         # Reset database (caution: deletes all data)

Development Commands

pnpm dev              # Start development server
pnpm dev:https        # Start with HTTPS using ngrok
pnpm build           # Build for production
pnpm start           # Start production server
pnpm analyze         # Analyze bundle size

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!