Starter

Create a new Iridium project with the following command:

bun create @iridium/cms@latest

Then you will be asked to provide a project name

? Project Name › my-admin

And instructed to install the dependencies and run the project

cd my-admin
bun install
bun run dev

Schema

iridium.config.ts is the main configuration file for Iridium. You can define your schemas here. Here is an example of a simple schema:

import { atom } from '@iridium/core';

const helloWorld = atom('hello world', {});

export const atoms = [
  helloWorld,
];

Create a User

To log into the admin, we'll need to generate an initial user. Run the following command and select "Create a User":

bunx iridium sync

Start

Start the development server and access http://localhost:3000 with your browser.

bunx iridium dev

Next Step

You should now have a running admin! See Atoms for how to build out the structure of your CMS!