Installation
Requirements
Before starting, ensure you have the following installed:- Node.js 18+ (latest LTS recommended)
- npm or another compatible package manager
- PostgreSQL database
- WorkOS application credentials
- Rust toolchain
- Tauri v2 CLI (for desktop builds)
Clone the Repository
Install Dependencies
Configure Environment Variables
Create a.env.local file in the project root.
Example configuration:
Environment Variable Details
DATABASE_URL
PostgreSQL connection string used by Prisma. Example:WORKOS_CLIENT_ID
Your WorkOS application client ID.WORKOS_API_KEY
Your WorkOS secret API key.WORKOS_COOKIE_PASSWORD
A long random string used for session encryption. You can generate one with:NEXT_PUBLIC_WORKOS_REDIRECT_URI
Authentication callback URL. For local development:Database Setup
Generate the Prisma client:Start the Development Server
Production Build
Build the application:Optional - Tauri Desktop
Run Desktop Development Build
Build Desktop Application
Troubleshooting
Prisma Client Errors
Regenerate the Prisma client:Migration Issues
Reset the local database:Port Already in Use
Run the app on another port:Next Steps
- Configure deployment environment variables
- Set up PostgreSQL backups
- Configure WorkOS authentication providers
- Build the optional Tauri desktop app