DEV Community

Lucas Vieira
Lucas Vieira

Posted on

How to easily manage your boilerplates and quickstart your projects

We as developers often need to create a brand new project which sometimes take long to setup it according to our needs and preferences.

In some cases, we have to literally spend hours configuring aux tools such as prettier, eslint, husky and so on.

To never experience that anymore, I developed a simple and powerful npm package, called boilermanager, to help developers to manage their own boilerplates.

Image description
Example: the above image shows this tool creating an electron typescript application with all tools configured in less than one minute

How to use it

To use this tool, you have to install Node.js and Git.

After have those softwares installed, simple install the package globally in your computer by running this command:

npm install boilermanager -g
Enter fullscreen mode Exit fullscreen mode

After that you can simple run any of the following options it the folder you want to create a new boilerplate project:

# you can either use "bpm" or "boilermanager"

bpm                      # will show all the nodejs default boilerplates
bpm -r [user/repository] # will show the boilerplates available in the specified repository
bpm -f [folder]          # will show the boilerplates available in the specified folder
Enter fullscreen mode Exit fullscreen mode

How to use it with my onw boilerplates?

I have created a basic boilerplates repository template, so you can understand how to setup your own projects the way boilermanager will accept.

In general, you’ll have to:

  • Fork or Copy this project to your github;
  • Clone into your local machine and put your boilerplates according to this repository;
  • Push the changes to your github remote repository, lets say it is githubuser/yourboilerplates
  • Load your repository, by running:
bpm -r githubuser/yourboilerplates
Enter fullscreen mode Exit fullscreen mode

Final words

This project initially was meant to be used for Node.js related projects, but it also can be used for any other technologies. I’m even going to add Golang boilerplates (in other repository) in the future, when I become more proficient at it.

Related

👉 If you want to check the repository source code, it is here;
👉 You can also find the default boilerplates available here;
👉 See also all my projects
👉 See also all my tutorials

Top comments (0)