Quick Start

Get OMOBL SSO up and running on your local machine in 5 minutes

5 minutes

Beginner friendly

Prerequisites

Make sure you have these installed before starting

Node.js 18+ - Download here
PostgreSQL 16+ - Or use SQLite for local development
Clerk Account - Sign up free
Git - For cloning the repository

Clone the Repository

Clone the repository from GitHub to your local machine:

Terminal

git clone https://github.com/Mediaflux-Math-Labs/sso-omobl-flux.git
cd sso-omobl-flux

Install Dependencies

Install all required npm packages:

Terminal

npm install

Configure Environment Variables

Create a .env.local file in the root directory:

.env.local

# Database (SQLite for local dev)
DATABASE_URL="file:./prisma/dev.db"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_..."
CLERK_SECRET_KEY="sk_test_..."
NEXT_PUBLIC_CLERK_SIGN_IN_URL="/sign-in"
NEXT_PUBLIC_CLERK_SIGN_UP_URL="/sign-up"

# Application
NEXT_PUBLIC_APP_URL="http://localhost:3000"

# Encryption (32-character key)
ENCRYPTION_KEY="your-32-character-key-here-1234"

Get your Clerk keys from the Clerk Dashboard. See the Environment Variables guide for details.

Set Up Database

For local development, we'll use SQLite. Update prisma/schema.prisma:

prisma/schema.prisma

datasource db {
  provider = "sqlite"  // Change from "postgresql" to "sqlite"
  url      = env("DATABASE_URL")
}

Then run migrations and seed the database:

Terminal

npx prisma migrate dev
npx tsx prisma/seed.ts

For production, use PostgreSQL. See the Deployment Guide for production database setup.

Start Development Server

Start the Next.js development server:

Terminal

npm run dev

Open your browser and navigate to http://localhost:3000

Next Steps

Now that you're up and running, explore these resources:

Learn about the System Architecture - Understand how OMOBL SSO is designed
Explore Authentication & Authorization - Learn about the four-tier role system
Check out the API Reference - Integrate with external applications
Read the Development Guide - Best practices for contributing

Quick Start

Get OMOBL SSO up and running on your local machine in 5 minutes

5 minutes

Beginner friendly

Prerequisites

Make sure you have these installed before starting

Node.js 18+ - Download here
PostgreSQL 16+ - Or use SQLite for local development
Clerk Account - Sign up free
Git - For cloning the repository

Clone the Repository

Clone the repository from GitHub to your local machine:

Terminal

git clone https://github.com/Mediaflux-Math-Labs/sso-omobl-flux.git
cd sso-omobl-flux

Install Dependencies

Install all required npm packages:

Terminal

npm install

Configure Environment Variables

Create a .env.local file in the root directory:

.env.local

# Database (SQLite for local dev)
DATABASE_URL="file:./prisma/dev.db"

# Clerk Authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_..."
CLERK_SECRET_KEY="sk_test_..."
NEXT_PUBLIC_CLERK_SIGN_IN_URL="/sign-in"
NEXT_PUBLIC_CLERK_SIGN_UP_URL="/sign-up"

# Application
NEXT_PUBLIC_APP_URL="http://localhost:3000"

# Encryption (32-character key)
ENCRYPTION_KEY="your-32-character-key-here-1234"

Get your Clerk keys from the Clerk Dashboard. See the Environment Variables guide for details.

Set Up Database

For local development, we'll use SQLite. Update prisma/schema.prisma:

prisma/schema.prisma

datasource db {
  provider = "sqlite"  // Change from "postgresql" to "sqlite"
  url      = env("DATABASE_URL")
}

Then run migrations and seed the database:

Terminal

npx prisma migrate dev
npx tsx prisma/seed.ts

For production, use PostgreSQL. See the Deployment Guide for production database setup.

Start Development Server

Start the Next.js development server:

Terminal

npm run dev

Open your browser and navigate to http://localhost:3000

Next Steps

Now that you're up and running, explore these resources:

Learn about the System Architecture - Understand how OMOBL SSO is designed
Explore Authentication & Authorization - Learn about the four-tier role system
Check out the API Reference - Integrate with external applications
Read the Development Guide - Best practices for contributing