https://github.com/rafaelgss/napd
Node API Project Design - CLI for generate structure base of api.
https://github.com/rafaelgss/napd
api-cli cli-boilerplate nodejs-boilerplate nodejs-cli
Last synced: 8 months ago
JSON representation
Node API Project Design - CLI for generate structure base of api.
- Host: GitHub
- URL: https://github.com/rafaelgss/napd
- Owner: RafaelGSS
- Created: 2019-04-15T17:51:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T01:28:19.000Z (almost 3 years ago)
- Last Synced: 2025-03-29T03:12:29.462Z (9 months ago)
- Topics: api-cli, cli-boilerplate, nodejs-boilerplate, nodejs-cli
- Language: JavaScript
- Homepage:
- Size: 1.08 MB
- Stars: 31
- Watchers: 3
- Forks: 5
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NAPD
[](http://standardjs.com/)
Node API Project Design - Cli for generate structure base of api.
## Installing globally
This is a [Node.js](https://nodejs.org/) module available through the
[npm registry](https://www.npmjs.com/). It can be installed using the
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
```bash
npm i -g napd
```
## Setup application
**Help:**
```bash
napd -h
```
**Initialize an application on current directory**
```bash
napd init
```
**Initialize an application on another directory**
```bash
napd init --dir DIRECTORY
```
## Templates
### API - Express ESM
API Base with ESM Modules - Check the [docs](templates/api/express/README.md)
### API - Fastify
API Base with Fastify - Check the [docs](templates/api/fastify/README.md)
### API - Fastify Typescript
API Base with Fastify and Typescript - Check the [docs](templates/api/fastify-typescript/README.md)
## Dependencies
- [caporal](https://ghub.io/caporal): A full-featured framework for building command line applications (cli) with node.js
- [enquirer](https://ghub.io/enquirer): Stylish, intuitive and user-friendly prompt system. Fast and lightweight enough for small projects, powerful and extensible enough for the most advanced use cases.
- [fs-extra](https://ghub.io/fs-extra): fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.
- [mv](https://ghub.io/mv): fs.rename but works across devices. same as the unix utility 'mv'
- [ora](https://ghub.io/ora): Elegant terminal spinner
## License
MIT