Quick Start

This guide walks you through starting both the backend API server and the frontend development server, then verifying everything works with health checks and API tests.

Start the Backend

1. 1

   Restore Dependencies

   Restore all NuGet packages for the solution.
   Shell

   Copy

   cd SCRIPE-Backend
   dotnet restore

2. 2

   Apply Migrations

   Run Entity Framework migrations to create or update the database schema.
   Apply migrationsShell

   Copy

   dotnet ef database update \
     -p src/Modules/Identity/Identity.Infrastructure \
     -s src/Host/API

3. 3

   Run the API Server

   Start the backend API server on https://localhost:5035.
   Shell

   Copy

   dotnet run --project src/Host/API

Start the Frontend

1. 1

   Install Dependencies

   Install all npm dependencies using pnpm for faster, disk-efficient installation.
   Shell

   Copy

   cd SCRIPE-Frontend
   pnpm install

2. 2

   Configure Environment

   Create a .env.local file with the API URL and app name.
   .env.localShell

   Copy

   # .env.local
   NEXT_PUBLIC_API_URL=https://localhost:5035
   NEXT_PUBLIC_APP_NAME=SCRIPE

3. 3

   Start Dev Server

   Start the Next.js development server on http://localhost:3000.
   Shell

   Copy

   pnpm dev

Default Credentials

Verify Installation

Once both servers are running, verify the installation using these checks.

curl https://localhost:5035/health
# Expected: {"status":"Healthy","results":{...}}

SCRIPE CLI

The SCRIPE CLI (scripe-cli) provides scaffolding commands to generate modules, entities, commands, queries, and more. It follows the project's architecture conventions automatically.

# Automatically create a 3-project backend module and frontend route
scripe new-module Inventory

# Scaffold 26 full-stack files (Controllers, Handlers, ViewModels, Zod schemas, Views)
scripe new-feature Inventory Product -p "Name:string:required:max(100),Price:decimal:required,CategoryId:FK:Category:required"

# Generate EF migrations across 3 Databases (SqlServer, Oracle, PostgreSql) simultaneously
scripe db add-migration Initial -m Inventory

# Auto-detect your configured Database provider and update it
scripe db update -m Inventory

# Auto-generate TypeScript models and API clients from Swagger
scripe sync-api https://localhost:5035/swagger/v1/swagger.json -m inventory

# Build the entire platform
scripe build all