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
- Requirements
- How to use
- Available Boilerplates
- Patterns and libs
- Contribute
- Gitflow recommendations
- Licence
This CLI supports Node.js from version v10.x
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
These are the available boilerplates to get your project started
- Nodejs: nodevader
- React: juggernaut
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
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 installConfig enviroment
Copy enviroment variables template
cp .env.template .envStart
npm startTo file a new a feature
- create a branch from
masterbranch. Use the pattern:feature/description - file a pull request on
masterbranch - since your PR is aproved, it will be merged to
masterbranch - in a moment in time we'll create a release, using the pattern:
release/vX.X.X