Skip to content

A command-line tool to quickly set up and initialize a new Kawkab backend project, streamlining the process of building scalable, high-performance server-side applications with TypeScript.

Notifications You must be signed in to change notification settings

kawkabjs/create-kawkab-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Create Kawkab

create-kawkab-app is a command-line interface (CLI) tool to create projects based on the Kawkab framework. This tool helps you quickly start new projects with a template and automatically installs the required dependencies.

Features

  • Create a new project based on the Kawkab framework.
  • Automatically installs dependencies using npm or Bun.
  • Quickly and easily set up new projects.

Prerequisites

  • Make sure you have Node.js or Bun installed on your machine.
  • Ensure that you're using a recent version of your chosen package manager (npm or Bun).

Installation

Using npm

To install the tool globally with npm, run:

npm install -g create-kawkab-app  

Using Bun

To install the tool globally with Bun, run:

bun add -g create-kawkab-app  

Usage

To create a new project using the Kawkab framework, you can use either npx (with npm) or bunx (with Bun):

Using npm

Run the following command to create a new project:

npx create-kawkab-app init <project-name>  

Using Bun

Run the following command to create a new project:

bunx create-kawkab-app init <project-name>  

Example

If you want to create a new project named my-kawkab-app, use the following command:

  • With npm:

    npx create-kawkab-app init my-kawkab-app  
  • With Bun:

    bunx create-kawkab-app init my-kawkab-app  

The project template will be copied to the new directory and dependencies will be installed automatically.

About

A command-line tool to quickly set up and initialize a new Kawkab backend project, streamlining the process of building scalable, high-performance server-side applications with TypeScript.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published