rafaelgss / napd

Node API Project Design - CLI for generate structure base of api.

NAPD

Node API Project Design - Cli for generate structure base of api.

Installing globally

This is a Node.js module available through the npm registry. It can be installed using the npm

npm i -g napd

Setup application

Help:

napd -h

Initialize an application on current directory

napd init <PROJECT_NAME> <TEMPLATE_TYPE>

Initialize an application on another directory

napd init <PROJECT_NAME> <TEMPLATE_TYPE> --dir DIRECTORY

Templates

API - Express ESM

API Base with ESM Modules - Check the docs

API - Fastify

API Base with Fastify - Check the docs

API - Fastify Typescript

API Base with Fastify and Typescript - Check the docs

Dependencies

• caporal: A full-featured framework for building command line applications (cli) with node.js
• 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: 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: fs.rename but works across devices. same as the unix utility 'mv'
• ora: Elegant terminal spinner

License

MIT

napd's Issues

[api/fastify] Add confirmation to use swagger and sentry

Just add to caporal for select what template choose, and what add-ons like Swagger, Sentry, etc...

[api/fastify] improve coverage of plugin

Needs improve coverage of plugin responseApi.js
Just add more tests here