typescript-cli-boilerplate

A simple Node CLI Boilerplate written in TypeScript.

Inspired by the excellent article "How to build a command-line app in Node.js using TypeScript, Google Cloud Functions and Firebase".

Dependencies

To run this project you need to have:

• Node
• Yarn

Setup the project

1. Install the dependencies above
2. $ git clone https://github.com/roalcantara/typescript-cli-boilerplate.git - Clone the project
3. $ cd typescript-cli-boilerplate - Go into the project folder
4. $ yarn - Run the setup script

Running specs

$ yarn test to run the specs

Running the project

Pokédex

• $ yarn pokedex -h to see the options
• $ yarn pokedex find to find Pokémons by name

IMDB

• $ yarn imdb -h to see the options
• $ yarn imdb screenshot to capture screenshots from the IMDB's website
• $ yarn imdb scrap to scrap move lists from the IMDB's website

How to contribute

1. Follow the Semantic Versioning Specification
2. Follow the GitHub Flow
3. Follow the 5 Useful Tips For A Better Commit Message article and the How to Write a Git Commit Message post
4. Use Commitizen cli when committing
5. Apply the Better Specs best practices for testing - as much as possible, obviously

License

This project is released under the MIT License.