Skip to content

Latest commit

聽

History

History
92 lines (61 loc) 路 2.29 KB

README.md

File metadata and controls

92 lines (61 loc) 路 2.29 KB
Raw

Adonis API application

馃敽 Inovando's template for adonis

code style: prettier Commitizen friendly

Package Main Techs

Usage

  1. Setup a PostgreSQL

  2. Modify .env fulfilling variables as needed

  3. Initialize your project with this command:

adonis new yardstick --blueprint=inovando/adonis-api-app
adonis migration:refresh --seed
  1. Run the following command:
adonis serve --dev
  1. Done 馃帀

PostgreSQL

Local install

Follow this link

Docker

docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres

Migrations

Run the following command to run startup migrations.

adonis migration:run

Seeds

Run the following command to run recreate the database and seed.

adonis migration:refresh --seed

Postman

  1. Download Postman

  2. Import our Postman Collection from postman/Template Adonis.postman_collection.json

Postman Collection | First Step Postman Collection | Second Step

  1. Import our Postman Environment from postman/Template Adonis.postman_environment.json

Postman Environment | First Step Postman Environment | Second Step Postman Environment | Second Step

Features

  • Bodyparser
  • Authentication
  • CORS
  • Lucid ORM
  • Migrations and seeds
  • Abstra莽茫o Controller/Repository
  • Bumblebee (include)
  • Enviar e-mails
  • M茅todo para autenticar, resetar senha
  • Endpoints /me
  • Abstra莽茫o de profiles
  • Upload de arquivos gen茅rico
  • Sentry
  • Redis Cache
  • User and Profile Seeder
  • Commitizen Friendly