Giter Club home page Giter Club logo

adonis-starter's Introduction

Adonis Custom Starter

This is a customized boilerplate of Adonis.js API blueprint. This boilerplate comes with:

  1. CRUD Service
  2. Lucid Model Integration with Validation
  3. Soft Delete Implementation
  4. Starter File Generator Commands
  5. Standardized Response w/ Internationalization
  6. Basic Exception Handlers
  7. Request Logger Middleware
  8. Custom Providers
  9. Conventional Commit Hooks

Setup

  1. Clone the repo using git and run npm install or yarn install.
  2. Generate app key using adonis key:generate.
  3. Create model with validation adonis starter:model <modelName> example : adonis starter:model profile
  4. Create generate crud controller adonis starter:crud <modelName> example : adonis starter:crud profile

Conventional Commit

  1. fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning).
  2. feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning).
  3. 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.
  4. 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/

Migrations

Run the following command to run startup migrations.

adonis make:migration <modelname>

adonis migration:run

adonis-starter's People

Contributors

hadianr avatar prazedotid avatar bawas07 avatar

Stargazers

 avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.