CleanAPI Generator v2.0

1. Description

The powerful and flexible API framework which is used Node.JS, Express and based-on Clean architecture

2. Installation

yarn install
node .

3. Checklist

3.1. Stage 01

• Build main UI
• Get project and database info
• Generate folder structure
• Generate file package.json
• Generate file README.md
• Generate file .gitignore
• Generate file server.js
• Generate files in utils folder
• Generate file config.js
• Generate Entities files
• Generate Data_provider files
• Generate Use_case files
• Generate Routes files
• Test phrase

3.2. Stage 02

• Add required and basic constraint into Entity
• Upgrade API method (GET, POST, PUT, PATCH, DELETE)
• Upgrade Middle-ware to check token / non-token API
• Upgrade utils libraries (update the latest functions in generator)
• Install some new necessary packages
• Uninstall some unnecessary packages
• Fix some old issues

3.3. Stage 03

• Auto format code with Prettier
• Auto check code style with ESLint
• Only uses const and let
• Upgrade pagination method
• Change to use .env file for configuration
• Change to use yarn instead of npm

Author

Dương Trần Hà Phương (Mr.) - CEO FPO Co.,Ltd

• Email: [email protected]
• Website: https://phuongduong.fpo.vn
• Gitlab: @dthphuong1
• Github: @dthphuong

License

MIT

Copyright © 2019-2021, Phuong Duong

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.