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.
Make sure you have these installed before starting
Get the command line tool installed on your system
npm install -g @realmkit/cli
realmkit --version
Explore the available project templates
realmkit list
realmkit search saas
realmkit info saas-starter
Generate a new project from a realm template
realmkit create saas-starter my-awesome-app
cd my-awesome-app && ls -la
Set up the project dependencies
cd my-awesome-app
npm install
npm list --depth=0
Launch the development server
npm run dev
Open http://localhost:3000
Your new project comes with everything you need to start building
Complete SaaS application with auth, payments, and admin panel
realmkit create saas-starter my-saas
Modern blog with MDX support and SEO optimization
realmkit create nextjs-blog my-blog
RESTful API with authentication and database integration
realmkit create api-starter my-api
Full-featured online store with payment processing
realmkit create e-commerce my-store
Now that you have a project running, here's how to make it your own
Common problems and solutions for getting started
If realmkit
command is not recognized:
npx @realmkit/cli --version
If realm creation doesn't work:
realmkit list