OSCRAT Platform (free and open source)

OSCRAT Platform - an open core, enterprise-ready trust management platform for startups and SMEs.

Please star the repo if you want us to continue developing and improving the OSCRAT Platform.

Structure

oscrat-oves/
├── apps/
│   ├── frontend/       # @oscrat/frontend (Next.js app)
│   └── jobrunner/      # @oscrat/jobrunner (background jobs)
├── packages/
│   └── model/          # @oscrat/model (Prisma schema, DB operations, types)
├── docker-compose.yml  # Local development services
└── package.json        # Workspace orchestrator

Built With

• SaaS-Starter-Kit
• Next.js
• Tailwind CSS and Atlaskit
• Postgres
• React
• Prisma
• TypeScript
• SAML Jackson (Provides SAML SSO, Directory Sync)
• Svix (Provides Webhook Orchestration)
• Endpoints collection (Provided by Osquery)

Deployment

To Be Done

Getting Started

Please follow these simple steps to get a local copy up and running.

Prerequisites

• Node.js (Version: >=22.x, see .nvmrc)
• PostgreSQL
• PNPM
• Docker compose
• Syft (required by the jobrunner for SBOM generation)
• Grype (required by the jobrunner for vulnerability scanning)
• openscap-report (required by the jobrunner for configuration scan reports)

Development

1. Setup

• Fork the repository
• Clone the repository by using this command:

git clone https://github.com/oscrat/OSCRAT.git

2. Go to the project folder

cd oscrat-oves

3. Install dependencies

pnpm install

4. Install Syft, Grype & openscap-report

The jobrunner shells out to these binaries — install them and make sure they're on your PATH. See syft, grype, and openscap-report.

5. Set up your .env file

Duplicate the root .env.example to .env:

cp .env.example .env

Keep CONFIRM_EMAIL=false in your local .env. No SMTP is wired up by default, so if email confirmation is on, new accounts will be stuck waiting for a confirmation email that never arrives.

6. Start local services (Database)

pnpm services:db:up

This starts a PostgreSQL container for local development.

7. Set up database schema

pnpm db:generate
pnpm db:migrate:dev

On a fresh database this applies every migration in packages/model/prisma/migrations/ in order and generates the Prisma client.

8. Start the development server

pnpm dev

This starts both the frontend and the jobrunner.

9. Start the Prisma Studio

Prisma Studio is a visual editor for the data in your database.

pnpm db:studio

Available Scripts

Root Level

• pnpm dev - Start all apps in development
• pnpm build - Build all apps
• pnpm typecheck - Type check all packages
• pnpm services:db:up - Start local PostgreSQL
• pnpm services:db:down - Stop local PostgreSQL
• pnpm db:generate - Generate Prisma client
• pnpm db:migrate:dev - Apply migrations locally
• pnpm db:studio - Open Prisma Studio
• pnpm db:reset - Reset the local database

Features

• Create account
• Sign in with Email and Password
• Sign in with Magic Link
• Sign in with SAML SSO
• Sign in with Google [Setting up Google OAuth]
• Sign in with GitHub [Creating a Github OAuth App]
• Directory Sync (SCIM)
• Update account
• Create team
• Invite users to the team
• Manage team members
• Update team settings
• Webhooks & Events
• Internationalization
• Audit logs
• Roles and Permissions
• Dark mode

License

Apache 2.0 — see LICENSE.