https://github.com/shubhranshu/nodejs-starter-template
NodeJs CLI starter template repository
https://github.com/shubhranshu/nodejs-starter-template
babel-cli chalk-cli cli github-actions github-workflow inquirer node-cli node-cli-learn node-esm node-template nodejs nodejs-cli nodejs-template nodemon starter starter-template startertemplate template
Last synced: about 1 month ago
JSON representation
NodeJs CLI starter template repository
- Host: GitHub
- URL: https://github.com/shubhranshu/nodejs-starter-template
- Owner: shubhranshu
- License: mit
- Created: 2020-04-10T01:39:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T03:09:25.000Z (over 2 years ago)
- Last Synced: 2025-03-18T10:11:27.460Z (about 1 month ago)
- Topics: babel-cli, chalk-cli, cli, github-actions, github-workflow, inquirer, node-cli, node-cli-learn, node-esm, node-template, nodejs, nodejs-cli, nodejs-template, nodemon, starter, starter-template, startertemplate, template
- Language: JavaScript
- Size: 1.22 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NodeJs CLI Starter template
Starter template to get going ith NodeJs CLI development without much fuss.
| Branch | | |
| ------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| develop |  |  |
| master |  |  |
## Configured tooling
- [x] ES6 support with babel
- [x] Test script with Ava
- [x] Watch scripts for run and tests
- [x] Babel, Prettier and Eslint configs
- [x] Github Actions for build and test
## Usage and Configuration
Using this template to initialise repository or copy the files as required. Or simply use it to get some inspiration.
### Scripts
- **build** : `Build the project and copy the built files to dist folder`
- **test** : `Run ava tests`
- **watch-test** : `Watch code and run tests on code change`
- **cli-run** : `Run the code without building`
- **watch-run** : `Use nodemon to watch code and run on change`
### Packages
We are using [npm](https://github.com/npm/cli) as the default package manager. To use [Yarn](https://github.com/yarnpkg/yarn) delete [package-lock.json](package-lock.json) and run `yarn`
- [chalk](https://github.com/chalk/chalk)
- [inquirer](https://github.com/SBoudrias/Inquirer.js)
- [progress](https://github.com/visionmedia/node-progress)
Dev dependencies
- [ava](https://github.com/avajs/ava)
- [babel](https://github.com/babel/babel)
- [eslint](https://github.com/eslint/eslint)
- [nodemon](https://github.com/remy/nodemon)
## To Do
- [ ] Being able to parameterise the setup
- [ ] Options for Test framework
- [ ] CLI setup without using the repository