Create-package-monorepo NPM

Create Package Monorepo

npm GitHub issues GitHub pull requests GitHub last commit GitHub

A powerful CLI tool for creating TypeScript-based monorepo packages with customizable templates and a demoable GitHub Pages website.

Features

Interactive CLI for streamlined package setup.
Seamless integration with NPM and GitHub.
Generate publishable packages and a demoable GitHub Pages website.

Prerequisites

Before you get started, make sure you meet these requirements:

Node.js installed on your machine.
An NPM account. Sign up here if you don't have one.
A GitHub account. Sign up here if you don't have one.
Git installed on your machine.

What's Included

The code generated by Create Package Monorepo includes a TypeScript-based monorepo structure consisting of publishable packages and a demoable GitHub Pages website. Here's the directory structure:

.template
├── LICENSE
├── README.md
├── package.json
├── packages
|  ├── __MY_PACKAGE_NAME__
|  |  ├── jest.config.js
|  |  ├── package.json
|  |  ├── src
|  |  |  ├── __tests__
|  |  |  └── index.ts
|  |  └── tsconfig.json
|  └── demo
|     ├── package.json
|     ├── src
|     |  ├── index.html
|     |  └── index.tsx
|     └── tsconfig.json
└── tsconfig.json

directory: 6 file: 12

Usage

Creating a new NPM package using Create Package Monorepo is simple. Run the following command:

npx create-package-monorepo

   ___ ____   ____  ___  ______  ____                     
  //   || \\ ||    // \\ | || | ||                        
 ((    ||_// ||==  ||=||   ||   ||==                      
  \\__ || \\ ||___ || ||   ||   ||___                     
 ____   ___    ___ __ __  ___    ___   ____               
 || \\ // \\  //   || // // \\  // \\ ||                  
 ||_// ||=|| ((    ||<<  ||=|| (( ___ ||==                
 ||    || ||  \\__ || \\ || ||  \\_|| ||___ 
 ___  ___   ___   __  __   ___   ____   ____ ____    ___ 
 ||\\//||  // \\  ||\ ||  // \\  || \\ ||    || \\  // \\ 
 || \/ || ((   )) ||\\|| ((   )) ||_// ||==  ||_// ((   ))
 ||    ||  \\_//  || \||  \\_//  || \\ ||___ ||     \\_//

Follow the on-screen prompts to configure your package:

Where do you want to create the NPM package?: Specify the directory where you want to create your package. The default is the current directory.
How do you want to name the NPM package?: Enter a unique name for your NPM package. Ensure it's not already in use on the NPM registry.
What is your NPM username?: Provide your NPM username.
What is your GitHub username?: Enter your GitHub username.

After answering these questions, the tool will generate your package with the specified configuration.

Your newly created package will be available in the specified directory. You can start adding code and customizing it to suit your project's needs.

Demoable GitHub Pages

The generated monorepo includes a demoable GitHub Pages website that allows you to showcase your package. Customize the demo as needed to demonstrate your package's capabilities.