https://github.com/mahabubx7/adonis-api-starter

REST-API starter with AdonisJS (v5) + PostgreSQL
https://github.com/mahabubx7/adonis-api-starter

adonis5 adonisjs adonisjs-framework lucid-orm rest-api typescript

Last synced: 1 day ago
JSON representation

REST-API starter with AdonisJS (v5) + PostgreSQL

• Host: GitHub
• URL: https://github.com/mahabubx7/adonis-api-starter
• Owner: mahabubx7
• License: mit
• Created: 2023-11-27T21:06:53.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2023-12-05T18:54:30.000Z (12 months ago)
• Last Synced: 2023-12-06T18:36:54.462Z (12 months ago)
• Topics: adonis5, adonisjs, adonisjs-framework, lucid-orm, rest-api, typescript
• Language: TypeScript
• Homepage:
• Size: 594 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AdonisJs (api-only)

### REST-API starter with AdonisJS (v5) + PostgreSQL

- Proper authentication with basic/normal examples ✅

- Email with SMTP ✅ & `mjml` + `edge` for email-templating

- Service generator ✅ @custom using `@adonisjs` core/command tool

- Token based (`Opaque`) ✅ for API authentication

- OTP ✅ for email verification & others

- Authorization ✅ using `@adonisjs/bouncer` with Todo CRUD + Policy-based access-controls

- Swagger API docs ✅ implementation with `autogen-swagger` from adonisjs-community-packages

- ✅ Write completed Tests for `Unit` & `Integration` (named as 'functional').

- ⌛Compose with `docker-compose.yml` with additional containers

- ⌛Use `@adonisjs/driver-s3` as file storage like `aws-s3` or `MinIO`

- ⌛(OPTIONAL): Integrate with BullMQ or Bull for Queue instead of InMemory-Adonis-Queue for sending emails

- ⌛(OPTIONAL): Implement query caching with redis + adonis/lucid-orm internals (if possible)

##### Latest updates as screenshoots: