Skip to content

BistroKit installation and usage

Héla Ben Khalfallah edited this page Jun 19, 2024 · 1 revision

BistroKit

BistroKit is a powerful CLI tool designed to streamline your project development process. Whether you're starting a new project or expanding an existing one, BistroKit provides everything you need to scaffold projects, set up configurations, and generate modules efficiently.

Features

  • Project Scaffolding: Easily initialize projects with popular frameworks like React, Angular, Next.js, and more. BistroKit sets up the required configurations, dependencies, and architecture.
  • Automated Configuration: Quickly set up tools like Jest, webpack, Vite, react-testing-library, linting, and more, ensuring your project is ready to go from the start.
  • Module Generation: Effortlessly create new pages, components, tests, and other modules with simple commands.
  • Customizable Recipes: Tailor your project setup to your preferences with customizable configurations.
  • Consistent Structure: Maintain a clean and organized codebase with standardized project structures.

Installation

To install BistroKit, use npm or pnpm:

npm install -g bistrokit

Usage

Initialize a New Project

To scaffold a new project, use the following command:

bistrokit init [project-name]

This command will create a new project directory with the required configurations and dependencies.

Generate a New Component

To generate a new component, use:

bistrokit generate component [component-name]

This will create a new component with the specified name in the appropriate directory.

Generate a New Page

To generate a new page, use:

bistrokit generate page [page-name]

This will create a new page with the specified name.

Generate a New Test

To generate a new test, use:

bistrokit generate test [test-name]

This will create a new test file with the specified name.

Start your next project with BistroKit and enjoy a delightful development experience!