Create Kawkab

A modern CLI tool to bootstrap new projects with the Kawkab framework.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• Project Structure
• Build
• Contributing
• License

Features

• Quickly scaffold a new project based on the Kawkab framework
• Automatic dependency installation (npm or Bun)
• Supports project templates
• Interactive and non-interactive modes

Prerequisites

• Node.js (recommended: latest LTS) or Bun
• A recent version of your package manager (npm or Bun)

Installation

Using npm

npm install -g create-kawkab-app

Using Bun

bun add -g create-kawkab-app

Usage

You can use npx (npm) or bunx (Bun) to create a new project:

Using npm

npx create-kawkab-app <project-name>

Using Bun

bunx create-kawkab-app <project-name>

Example

To create a project named my-kawkab-app:

• With npm:

  npx create-kawkab-app my-kawkab-app

• With Bun:

  bunx create-kawkab-app my-kawkab-app

The template will be copied and dependencies installed automatically.

Project Structure

A generated project typically looks like:

my-kawkab-app/
  ├── app/
  ├── storage/
  ├── package.json
  ├── tsconfig.json
  ├── ...

Build

To build (compile TypeScript to JavaScript):

1. Install dependencies (if you haven't already):

   npm install

2. Build the project using the build script:

   npm run build

This will compile all TypeScript files and output JavaScript to the dist directory (or as configured in tsconfig.json).

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page or submit a pull request.

License

This project is MIT licensed.