The create-akinon-app command is the fastest way to create a new Akinon UI Protocol project. It provides an interactive setup experience that guides you through creating the perfect project for your needs.

Quick Start

Create a new project with the latest version:

npx create-akinon-app@latest

This command will:

1. Ask you to provide a project name
2. Let you choose from available project types
3. Install dependencies automatically
4. Set up your development environment

Interactive Setup Process

When you run the command, you’ll be prompted with the following questions:

Project Name

Enter the name for your project. This will be used as:

• The directory name where your project is created
• The package name in package.json
• The display name in development

Project Type

Choose from four available project templates:

• Fullpage App - A standalone full-page application for complete user interfaces
• Plugin App - A smaller component that embeds within main applications
• Multi-App Fullpage - Multiple full-page applications in a single project
• Multi-App Plugin - Multiple plugin applications in a single project

Dependency Installation

The CLI will ask if you want to install dependencies immediately. If you choose yes, it will:

• Detect your preferred package manager (pnpm, npm, or yarn)
• Install all required dependencies
• Set up your development environment

What Gets Created

Each project includes:

• TypeScript configuration - Full TypeScript support out of the box
• Testing setup - Vitest configuration with example tests
• Development scripts - Ready-to-use npm scripts for development
• Shell development server - Built-in development environment
• UI Kit integration - Pre-configured Akinon UI components
• Linting and formatting - ESLint and Prettier configurations

Project Structure

my-project/
├── src/
│   ├── config.ts          # Application configuration
│   ├── main.tsx           # Application entry point
│   └── ...                # Project-specific files
├── __tests__/             # Test files
├── package.json           # Dependencies and scripts
├── tsconfig.json          # TypeScript configuration
├── vite.config.ts         # Vite build configuration
└── vitest.config.ts       # Test configuration

Available Scripts

After creation, your project will have these scripts available:

# Start development server
pnpm dev
 
# Start development with shell environment
pnpm dev:shell
 
# Run tests
pnpm test
 
# Run tests in watch mode
pnpm test:run
 
# Build for production
pnpm build
 
# Lint code
pnpm lint
 
# Format code
pnpm format

Command Line Options

For automated workflows, you can skip the interactive prompts by providing options:

Example with Options

# Create a plugin project without prompts
npx create-akinon-app@latest --name "my-plugin" --type plugin
 
# Create a fullpage app and skip dependency installation
npx create-akinon-app@latest --name "my-app" --type fullpage --install false

Next Steps

Once your project is created:

1. Navigate to your project directory:

   cd my-project

2. Start the development server:

   pnpm dev

3. Try the shell development environment:

   pnpm dev:shell

4. Run tests to ensure everything works:

   pnpm test

The shell development server provides a realistic testing environment that simulates how your application will behave when integrated with Omnitron or other main applications.