boilerplate-ui-kit

boilerplate-ui-kit is a CLI tool that generates a boilerplate project for HALO. It allows you to set up a React application using Vite, Webpack, or Turborepo and optionally include Docusaurus for documentation.

Features

• Supports multiple package managers: pnpm, npm, yarn
• Supports different bundling tools: Vite, Webpack, Turborepo
• Supports JavaScript and TypeScript
• Supports Material UI,Bootstrap,Radix
• Option to include Docusaurus for documentation

Installation

You can install boilerplate-ui-kit globally using:

npm install -g boilerplate-ui-kit

Usage

To create a new project, run:

boilerplate-ui-kit create <project-name>

OR

npx boilerplate-ui-kit create <project-name>

Options

During setup, you will be prompted to choose:

1. Package Manager: pnpm, npm, yarn
2. Bundler: Vite, Webpack, Turborepo
3. Language: JavaScript, TypeScript
4. UI framework : Material UI,Bootstrap,Tailwind,Radix
5. Whether to include documentation using Docusaurus

Example Usage

Create a React project using Vite and include Docusaurus

boilerplate-ui-kit create my-project

After following the prompts, the CLI will:

• Create the project directory
• Initialize the React app with the chosen bundler and language
• Install dependencies
• If selected, set up Docusaurus inside the project
• Start the development server with both React and Docusaurus

Project Structure

my-project/
│── docs/                # Docusaurus documentation
│── src/                 # React app source code
│── package.json         # Project dependencies and scripts
│── docusaurus.config.js # Configures Docusaurus (if Docusaurus is chosen)
│── vite.config.js       # Vite configuration (if Vite is chosen)
│── webpack.config.js    # Webpack configuration (if Webpack is chosen)
│── turbo.json           # Turborepo configuration (if Turborepo is chosen)

How It Works

• Creates react template using Vite, Webpack and Turborepo
• If Choosen also adds Auth0, UI frameworks like Material,Bootstrap,Redix.
• If Docusaurus is included, the CLI modifies docusaurus.config.js to serve documentation .
• Runs the Docusaurus build to generate static files.

Troubleshooting

If you encounter issues, try:

• Ensuring you have Node.js installed (>=14.0 recommended)
• Checking your package manager installation (pnpm, npm, yarn)
• Running npm install inside the project directory
• Checking logs for errors

Contributing

Feel free to contribute to this project by submitting issues or pull requests.

License

MIT License