Skip to Content
UntitledOne Docs preview
Installation

Installation

This guide will help you set up UntitledOne for development or production use.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js 18.17 or later
  • npm or pnpm
  • Git

Development Setup

1. Clone the Repository

git clone https://github.com/your-username/untitledone.git cd untitledone

2. Install Dependencies

npm install # or pnpm install

3. Environment Configuration

Copy the example environment file and configure your variables:

cp .env.example .env.local

Update the following environment variables in .env.local:

SUPABASE_URL=your_supabase_url SUPABASE_ANON_KEY=your_supabase_anon_key SUPABASE_SERVICE_ROLE_KEY=your_supabase_service_role_key SUPABASE_DB_URL=your_database_url RESEND_API_KEY=your_resend_api_key NEXT_PUBLIC_SITE_URL=http://localhost:3000

4. Database Setup

Run the database migrations:

npm run db:migrate

Generate TypeScript types from your database schema:

npm run gen:types

5. Start Development Server

npm run dev

Your application will be available at http://localhost:3000.

Production Deployment

For production deployment instructions, see our Deployment Guide.

Last updated on