WhiteLabel CLI - Project starter

A Node CLI project starter with Typescript to create a new instance of a WhiteLabel project

Prerequisites

This project requires NodeJS (version 16 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
v16.12.0
v8.16.0

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npx -p wlv2-starter@latest

Or install it globally:

$ npm install -g wlv2-starter@latest

Usage

| Command | alias | Description | Options | example | | ------- | ----- | --------------------------- | ------------------------------------ | ---------------------------------- | | init | i | Initialize a new project | -p "ProjectName"-b "BranchName" | wlv2-starter init -p "MyProject" | | env | e | Setup environment variables | | wlv2-starter env "MyProject" | | icons | ic | Setup app icons | | wlv2-starter icons "MyProject" | | colors | c | Setup app colors | | wlv2-starter colors "MyProject" | | bundles | b | Setup app bundles | | wlv2-starter bundles "MyProject" | | version | v | Show version number | | wlv2-starter --version | | help | h | Show help | |

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :sunglasses:

Credits

TODO: Write credits

Built With

• NodeJS - Node.js®
• NPM - npm
• Typescript - TypeScript
• Commander - Commander.js

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.