rmnr
DocsLayoutsModulesDirectoryBest PracticeAgentsInstall

Command Palette

Search for a command to run...

New
  • Introduction
  • Installation
  • Architecture
  • Stack
  • Directory
  • Install with Agent
    new
  • Bundle Builder
    new
  • MCP server
    new
  • VPS Control Room
    new
  • Changelog
    new
  • All website templates
    new
  • Personal Brand OS
  • Agency Studio OS
  • Notion Page Clone OS โ€” localStorage demo (pointer to open-silong for production)
  • SaaS Marketing OS
  • Kreator Studio OS
  • Konsultan OS
  • Wirausaha OS
  • Riset Kit
  • All layouts
  • 19
  • 3
  • 6
  • All slices
    new
  • 2
  • 2
  • 6
  • 3
  • 3
  • 1
  • 1
  • 7
  • 24
  • 6
  • All recipes

Get Started

Installation

Two paths. Pick one.

CLI scaffold (recommended)

One command. Scaffolds Next 16 + React 19 + Tailwind 4 + Convex self-hosted + shadcn/ui into a fresh empty folder. Cross-platform โ€” macOS / Linux / Windows PowerShell + WSL.

terminalbash
# Scaffold
npx rahman-resources@latest init my-app

# With every shadcn primitive pre-baked (recommended for heavy customization):
npx rahman-resources@latest init my-app --with-shadcn-all

# With a full-app template (public + admin route trees):
npx rahman-resources@latest init my-app --template personal-brand-os

# Then:
cd my-app
cp .env.example .env.local        # fill NEXT_PUBLIC_CONVEX_URL
npx convex dev --once             # generates convex/_generated
npm run dev                       # http://localhost:3000

Browse the catalog at /templates or use the visual Bundle Builder to compose template + slices + skills.

Clone the repo (contributors)

Only needed if you're contributing back to rr (adding slices, editing templates, fixing the CLI). Consumers use npx rr init above.

terminalbash
git clone https://github.com/rahmanef63/resource-site resources
cd resources
npm install --legacy-peer-deps
npm run dev
Open repo

With AI agent

The agent will fetch the knowledge base, clone the repo, copy template-base + chosen layout/recipes, install deps, generate Convex types, and run audit-bp.

agent-prompt.mdmarkdown
# Scaffold "Rahman Resource" into my-app

Pull only the folders + files listed below from `rahmanef63/resource-site`. Do not clone the whole repo.

๐Ÿ“š Knowledge base: https://resource.rahmanef.com/llms.txt
๐Ÿ“ฆ Source repo:    https://github.com/rahmanef63/resource-site

## 0. (Fresh project only) Scaffold via `init`

Skip this section if you already have a Next 16 project.

```bash
npx rahman-resources init my-app
cd my-app
cp .env.example .env.local   # fill NEXT_PUBLIC_CONVEX_URL
npm install --legacy-peer-deps
npx convex dev --once         # generates convex/_generated
```

`init` ships a minimal Next 16 + React 19 + Tailwind 4 + Convex + shadcn/ui skeleton (~18 files).

## 1. Pull only these folders

Option A โ€” `rr` CLI (recommended; auto-detects TEMPLATE vs SLICE, auto-augments `.env.example`, auto-installs deps):
```bash
npx rr add <slug> my-app
# alias of: npx rahman-resources add ...
```

Option B โ€” degit (no .git history, fastest manual path):
```bash
```

Option C โ€” git sparse-checkout (keeps history, single clone):
```bash
git clone --filter=blob:none --sparse --branch main https://github.com/rahmanef63/resource-site.git _tmp-resource-site
cd _tmp-resource-site
git sparse-checkout init --cone
git sparse-checkout set 
cd ..
rm -rf _tmp-resource-site
```

## 2. Wire it up

Adjust path aliases in `tsconfig.json` so imports resolve (`@/*` โ†’ project root).
Read `CLAUDE.md` of the source repo + `/best-practice` (12-rule doctrine) for hard rules (no Clerk, shadcn-only, copy-first, Next 16 + @convex-dev/auth, 200-LOC file cap, slice metadata trio).

Then run the audit chain:
```bash
npm run validate:all   # slices + templates + file-size + manifests + contracts
```
View llms.txt โ†’

Pre-flight

For first-time setup:

  • Node 20+
  • pnpm or npm
  • SSH access to GitHub for deploy
  • Shell env for deploy: DOKPLOY_API_URL, DOKPLOY_API_KEY, GITHUB_TOKEN