stanleygomes/endor-cli

Endor CLI - A Boilerplate Starter 🚀

Endor CLI

A Boilerplate Starter. Come to javascript side 🚀

The main goal of Endor CLI is to make it easy to start a javascript project using great and minimal boilerplates.

---

Table of contents

0. Requirements
1. How to use
2. Available Boilerplates
3. Patterns and libs
4. Contribute
5. Gitflow recommendations
6. Licence

---

📝 Requirements

This CLI supports Node.js from version v10.x

🚀 How to use

First time you'll need to install the package from npm globally

npm i -g endor-cli

Now you're ready to rock and create your first app

endor-cli create

💯 Available Boilerplates

These are the available boilerplates to get your project started

• Nodejs: nodevader
• React: juggernaut

✔️ Patterns

These are some of patterns definitions to help us to keep a default arquitecture

• Package manager: npm, sure
• Node version: v10.x
• Linter: eslint standard pattern
• i18n: take a look here
• Date and time: moment
• Test: Mocha & Chai
• Logs: use Winston

✌️ How to get contribute

Step by step to get this up and running

Clone repo and go to project folder

git clone https://github.com/stanleygomes/endor-cli.git && cd endor-cli

Install dependencies

npm install

Config enviroment

Copy enviroment variables template

cp .env.template .env

Start

npm start

🔱 Git flow

To file a new a feature

• create a branch from master branch. Use the pattern: feature/description
• file a pull request on master branch
• since your PR is aproved, it will be merged to master branch
• in a moment in time we'll create a release, using the pattern: release/vX.X.X

📜 License

MIT license. Copyright (c) 2021 Stanley.
For more information, see the LICENSE file.

endor-cli's Issues

Upgrade to node v12.x LTS

Upgrade

• docs on readme
• add engines to package json
• and dockerfile server/bin/nodejs/Dockerfile
• Github workflow