adonisjs-tdd-typescript-example-app icon indicating copy to clipboard operation
adonisjs-tdd-typescript-example-app copied to clipboard

Real World Application built with AdonisJS5, Typescript and TDD

RealWorld Example App

AdonisJS 5 codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with AdonisJS 5 including CRUD operations, authentication, routing, pagination, all of this using TDD.

I've gone to great lengths to adhere to the AdonisJS 5 community styleguides & best practices.

For more information about the API built here, head over to the API Specs.

Getting started

  • Install dependencies:
$ yarn
  • Create your .env file based on .env.example
  • Generate an app key for adonis project:
$ node ace generate:key
  • Run migrations:
$ node ace migration:run
  • Run tests:
$ yarn test
  • Start dev server:
$ yarn dev

For other commands, follow AdonisJS documentation.