Skip to content
rmnr
DocsTourSlicesBest PracticeAgentsInstall

Command Palette

Search for a command to run...

New
  • Introduction
  • Installation
  • Architecture
  • Stack
  • Directory

Get Started

Installation

Choose a renderer and a package manager. The CLI keeps the two decisions independent.

1. Choose the framework

Next.js + React

default

Full-app scaffold with Next.js 16, React 19, Tailwind 4, Convex and shadcn/ui. Existing full-app templates target this path.

SvelteKit + Svelte

native

SvelteKit 2 + Svelte 5 Runes, Tailwind 4, convex-svelte and adapter-node. Add any of the 66 canonical active slices with --framework sveltekit.

Framework parity is at the slice layer. Full-app templates are still Next.js-specific; SvelteKit projects start from the base scaffold and compose Svelte-ready slices.

2. Choose npm or Bun

Next.js / React

npm
npm.shbash
npx rahman-resources@latest init my-app --framework react-next --package-manager npm
cd my-app
npm run dev
Bun
bun.shbash
bunx rahman-resources@latest init my-app --framework react-next --package-manager bun
cd my-app
bun run dev

SvelteKit / Svelte 5

npm
npm.shbash
npx rahman-resources@latest init my-app --framework sveltekit --package-manager npm
cd my-app
npm run check
npm run dev
Bun
bun.shbash
bunx rahman-resources@latest init my-app --framework sveltekit --package-manager bun
cd my-app
bun run check
bun run dev

Existing projects are auto-detected from packageManager, rr.json, or lockfiles including modern bun.lock.

3. Add slices

terminalbash
# Next.js default
npx rahman-resources@latest add appshell

# SvelteKit
npx rahman-resources@latest add appshell --framework sveltekit

# Same Svelte install through Bun
bunx rahman-resources@latest add appshell --framework sveltekit --package-manager bun

Browse Slices for the exact Next/Svelte dependency matrix, or use the Bundle Builder to emit commands.

With AI agent

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 โ†’

Contributors

terminalbash
git clone https://github.com/rahmanef63/resource-site resources
cd resources

# npm
npm install --legacy-peer-deps --include=dev
npm run dev

# or Bun
bun install
bun run dev
Open repo

Fresh app scaffolds support npm and Bun directly. The rr repository keeps its committed npm lockfile as the release lock for CI reproducibility.