Skip to content

maestrya/api

Repository files navigation

Maestrya API

Maestrya is another project for academic purposes with AdonisJS and Domain Driven Design , and standardize the return structure

Trello:

Project in Heroku:

Required:

Optional:

Postamn

The folder Postman contains postman collection and environment variables for tests

Architecture

  • App
    • Domain = Responsible for delegate responsibilities for business rules
      • Command = Responsible for centralizing resources as Validations, Repositories and Entities
    • Helpers = Responsible for centralizing resources to help other layers
    • Infrastructure = Responsible for centralizing infrastructure related
      • Entities = Responsible for handle entities
      • Models = Responsible for connection and ORM with database
      • Repositories = Responsible for queries with database (extends Models)
  • Database
    • Migrations = Responsible for the database structure
    • Seeds = Responsible for the default data in database
  • Start
    • App = Responsible with providers in application
    • Kernel = Responsible with middlewares in application
    • Routes = Responsible with HTTP routes (relationship with Commands)

Install Adonis.JS

Run

npm i -g @adonisjs/cli

Setup without docker

Install project

npm install

If you have problem with PERMISSIONS

npm install --unsafe-perm

Run without docker

adonis serve

Setup & Run with docker

Run docker-compose in background (-d)

docker-compose up -d

Migrations && Seeds

Run the following command to run startup migrations.

npm run db

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages