Documentation/Quick Start

Quick Start Guide

Get up and running with RealmKit in under 10 minutes. This guide will take you from installation to having a fully functional project running locally.

Total Time
Approximately 10-15 minutes
Beginner Friendly

Prerequisites

Make sure you have these installed before starting

Node.js 18+
JavaScript runtime
npm or yarn
Package manager

Step-by-Step Guide

1
Install RealmKit CLI
2 minutes

Get the command line tool installed on your system

Commands

npm install -g @realmkit/cli

Verify

realmkit --version

2
Browse Available Realms
3 minutes

Explore the available project templates

Commands

realmkit list
realmkit search saas

Verify

realmkit info saas-starter

3
Create Your Project
2 minutes

Generate a new project from a realm template

Commands

realmkit create saas-starter my-awesome-app

Verify

cd my-awesome-app && ls -la

4
Install Dependencies
3 minutes

Set up the project dependencies

Commands

cd my-awesome-app
npm install

Verify

npm list --depth=0

5
Start Development
1 minute

Launch the development server

Commands

npm run dev

Verify

Open http://localhost:3000

What You Get

Your new project comes with everything you need to start building

Project Structure
Organized file layout with best practices
Pre-configured
ESLint, Prettier, TypeScript ready
Documentation
AI-optimized context files included
Ready to Run
Development server starts immediately

Popular Starter Templates

saas-starter

Complete SaaS application with auth, payments, and admin panel

SaaS
Features
Next.js 14
Prisma
Stripe
Auth.js
Quick Start
realmkit create saas-starter my-saas

nextjs-blog

Modern blog with MDX support and SEO optimization

Blog
Features
Next.js
MDX
Tailwind
SEO
Quick Start
realmkit create nextjs-blog my-blog

api-starter

RESTful API with authentication and database integration

API
Features
Express.js
JWT
PostgreSQL
Swagger
Quick Start
realmkit create api-starter my-api

e-commerce

Full-featured online store with payment processing

E-commerce
Features
Next.js
Stripe
Inventory
Admin
Quick Start
realmkit create e-commerce my-store

Having Issues?

Common problems and solutions for getting started

CLI not found after installation

If realmkit command is not recognized:

  • • Restart your terminal
  • • Check if npm global bin is in your PATH
  • • Try npx @realmkit/cli --version

Project creation fails

If realm creation doesn't work:

  • • Check your internet connection
  • • Ensure the realm name is correct: realmkit list
  • • Try creating in a different directory