bootstrap-project-cli

Bootstrap Project CLI

The Bootstrap Project CLI is a command-line interface tool to help you quickly bootstrap new projects with customizable templates.

Summary

• Installation
• Usage
• Template
• Possible options
• Example
• Contributing

Installation

Prerequisites

You need to have node and npm installed on your machine so make sure to check if it's installed by running :

node -v
npm -v

You can install the Bootstrap Project CLI globally using npm:

npm install -g bootstrap-project-cli

Or just locally :

npm install bootstrap-project-cli

Usage

To create a new project, run the following command:

bootstrap-project <project-name>

Or just run:

bootstrap-project

To have a help for each steps (with a real wizard 🧙‍♂️), this will let you choose your template, your dependencies.

Template

The Bootstrap Project CLI provides several project templates to choose from :

• browser: A template for browser-based projects using vanilla JavaScript and HTML
• javascript: A template for Node.js projects using JavaScript
• typescript: A template for Node.js projects using TypeScript

To choose a template, pass the --template flag followed by the name of the template you want to use. The default template is javascript.

Possible options

You can also pass additional options to customize your project using flags :

• --git : Initialize a Git repository
• --husky : Initialize Husky Git hooks
• --prettier : Initialize Prettier code formatter
• --eslint : Initialize Eslint Javascript linter
• --template : Choose a project template. The default is JavaScript.
• --yes : Skip prompts and use default options

Example

For example, to create a new TypeScript project with Git and Husky, you can run :

bootstrap-project my-typescript-project --git --husky --template typescript

Or just run:

bootstrap-project

And you can choose typescript for the template, git and husky in the helping wizard 🧙‍♂️.

Contributing

Contributions are welcome ! If you want to contribute, please follow these steps:

• Fork the repository
• Clone the repository to your local machine
• Create a new branch for your changes
• Make your changes and commit them
• Push your changes to your fork
• Submit a pull request

Please make sure your code follows the existing coding style before submitting a pull request.

License

This project is licensed under the MIT License.