/preparatorul

A simple node CLI to update a project with different configurations based on the project type. Day to day using.

Primary LanguageShell


preparatorul

cook your project


📚 Project Definition

NodeJS cli tool to populate project with most used files(eg: Docker configuration)

🛠️ Features

Technologies used:

  • ⚛️ NodeJS
  • 🌐 Inquirere — Library to create CLI tools
  • 🌐 Docker - Containerization sistem

🚀 Instalation

npm install -g preparatorul

OR

npx preparatorul

🔋 Commands

Go to your project and

preparatorul

💻 Development

run

node src/index.js
npm run lint

💻 NPM publish

  • increment "version": in package.json
  • push to master branch
  • npm-publish.yml will do the work

🌐 Docker development setup

  • run docker-compose up -d inside root

🔌 Custom configuration

The package can be configured according to the needs of each one.

For this you must add the desired template in the installation location of the package.

eg:

  • Windows

    $USERPROFILE\AppData\Roaming\npm\node_modules\preparatorul\src\templates\

  • Linux

    /usr/local/lib/node_modules/preparatorul/src/templates

TODO

  • increment version only when merging to dev
  • automatic version update when push to master (npm --no-git-tag-version version minor, patch etc) / check from the last push if version was changed