This is a customized boilerplate of Adonis.js API blueprint. This boilerplate comes with:
- CRUD Service
- Lucid Model Integration with Validation
- Soft Delete Implementation
- Starter File Generator Commands
- Standardized Response w/ Internationalization
- Basic Exception Handlers
- Request Logger Middleware
- Custom Providers
- Conventional Commit Hooks
- Clone the repo using git and run
npm install
oryarn install
. - Generate app key using
adonis key:generate
. - Create model with validation
adonis starter:model <modelName>
example :adonis starter:model profile
- Create generate crud controller
adonis starter:crud <modelName>
example :adonis starter:crud profile
- fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
- feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
- BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type. types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the the Angular convention) recommends build:, chore:, ci:',docs:,style:,refactor:,perf:,test:, and others.
- footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
example: git commit
commit messages:
fix: fix error login user
for description details : https://www.conventionalcommits.org/
Run the following command to run startup migrations.
adonis make:migration <modelname>
adonis migration:run