scaffold-master

Scaffold Master - NPM Package Documentation

Table of Contents

1. What is scaffold-master?
2. Installation
3. Usage
   • Getting Started
   • Creating a Project
   • Custom Boilerplate
4. Dependencies
5. Contributing
6. License

1. What is scaffold-master?

Scaffold Master is a lightweight npm package that helps to generate, create and manage boilerplates so they can be reproduced easily. Boilerplates can be anything from code snippet files to production-ready templates.

2. Installation

To install Scaffold Master, make sure you have Node.js and npm installed, then run the following command:

npm install -g scaffold-master

This will install Scaffold master globally on your system, allowing you to use it from anywhere in the terminal

3. Usage

3.1 Getting Started

Once Scaffold Master is installed, you can use it by running the sm-generate command in your terminal:

sm-generate

This will present you with a list of available boilerplate templates.

3.2 Generating a boilerplate

To create a new project using Scaffold Master, follow these steps:

1. Run sm-generate in your terminal.
2. Choose the desired boilerplate template from the list.
3. Make sure to run npm i if there is a package.json file.

After providing all the required information, Scaffold master will copy the selected boilerplate template to your current working directory.

3.3 Saving your own boilerplate

Scaffold Master also allows you to add your custom boilerplate templates. To do this, follow these steps:

1. Type sm-create in your terminal.
2. Enter the folder name for your custom boilerplate.
3. Select the files to ignore.

Your custom boilerplate template will be saved and can be used for future projects.

3.4 Deleting saved boilerplates

You can remove any saved boilerplates using Scaffold-master. To do this, follow these steps:

1. Type sm-delete in your terminal.
2. Select the boilerplate you want to delete from the list of saved boilerplates

The boilerplate which you selected will be deleted. This action is irreversible.

4. Contributing

If you would like to contribute to Scaffold Master, feel free to open issues or submit pull requests on the project's GitHub repository. Your contributions are highly appreciated!

5. License

Scaffold Master is open-source software licensed under the MIT License.

Thank you for using Scaffold Master! If you encounter any issues or need further assistance, please don't hesitate to reach out to us on the GitHub repository. Happy coding!