Installation

Get UNuxt running locally in a few steps.

Prerequisites

• Node.js 20+
• pnpm 9+
• Docker (for the database)

Clone the repository

git clone https://github.com/leighayanid/unuxt.git
cd unuxt

Install dependencies

pnpm install

npm install

yarn install

bun install

Configure environment variables

Copy the example environment file and fill in your values:

cp .env.example .env

Key variables to configure:

Start the database

Start PostgreSQL using Docker:

docker-compose -f docker-compose.dev.yml up -d

Run database migrations

Push the schema to your database:

pnpm db:push

Start the development server

pnpm dev

Visit http://localhost:3000 to see your application.

Verify installation

You should see the UNuxt landing page. Try these to verify everything works:

1. Navigate to /auth/register to create an account
2. Check the login flow at /auth/login
3. Open Drizzle Studio with pnpm db:studio

Next steps

• Configure authentication
• Set up organizations
• Customize the theme