osiris-cms-template

Osiris CMS Template

A command-line tool for quickly generating CMS projects with your choice of UI library: Material-UI (MUI) or Ant Design.

Features

• Interactive CLI experience
• Choose between Material-UI or Ant Design
• TypeScript support with Vite
• Pre-configured routing
• Ready-to-use admin dashboard layout
• Login page template

Installation

# Install globally
npm install -g osiris-cms-template

# Or use with npx without installing
npx osiris-cms-template

Usage

After installation, run the CLI by using the command:

# Just run the command
osiris

# Or with the explicit run command
osiris run

Follow the interactive prompts to:

• Enter your project name
• Choose your preferred UI library (MUI or Ant Design)

The CLI will then:

• Create a new directory with your project name
• Set up a TypeScript + Vite + React project
• Configure your chosen UI library
• Install all dependencies
• Provide you with next steps

Project Structure

The generated project will have the following structure:

my-project/
├── public/
├── src/
│   ├── components/
│   │   └── Layout.tsx
│   ├── pages/
│   │   ├── Dashboard.tsx
│   │   └── Login.tsx
│   ├── App.tsx
│   ├── index.css
│   ├── main.tsx
│   └── theme.ts (for MUI projects)
├── index.html
├── package.json
├── tsconfig.json
├── tsconfig.node.json
└── vite.config.ts

Requirements

• Node.js v14 or higher

License

MIT