/create-boilerplate-cli

A CLI tool to create react.js and node.js projects with the necessary tooling

Primary LanguageRubyMIT LicenseMIT

Create Boilerplate CLI

Description

A command line interface tool to create boilerplate for react.js and node.js projects.

Less time setting up the tooling, more time developing.

Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows. RubyGem version RubyGem downloads Last commit License

Motivation

Every time I started a project with react.js or node.js, I had to set up a several tooling, such as Prettier, ESLint, etc.

I decided to create a tool for myself that will set those up for me automatically from a few questions.

Diagram / Screenshot / GIFs

asciicast

Features

  • Supports react.js and node.js projects, with or without TypeScript
  • Sets up ESLint, Prettier while taking into account for TypeScript
  • stylefmt and stylelint
  • Sets up Husky pre-commit and commit message hooks
  • Sets up lint-staged
  • Sets up nodemon for node.js projects

Getting started

The script is written in Ruby, simply because it is enjoyable to write with and it comes pre-installed on macOS (my OS of preference).

Prerequisites

Must have the following installed:

  • Ruby >= 2.6
  • NPM >= 5.2.0

Configuration

Run the command and answer the prompts.

Installing

gem install init-boilerplate

Usage

Navigate to a fresh directory where you want to start your project and run the following command.

init-boilerplate

Roadmap

  • Add Git boilerplate
    • README outline, templates, etc.
  • Create and publish Ruby Gem

Authors

@gordonpn

License

MIT License