Adonis 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 Adonis including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the Adonis community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Getting started

Clone the repository

git clone [email protected]

Install dependencies

npm install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

npx adonis key:generate

Run migration

node ace migration:run

Start the local development server

npm run dev

Run tests

npm test

For more information run

node ace --help

adonisjs.com

API Specification

This application adheres to the api specifications set by the Thinkster team. This helps mix and match any backend with any other frontend without conflicts.

Full API Spec

More information regarding the project can be found here https://github.com/gothinkster/realworld

Environment variables

.env - Environment variables can be set in this file

Note : You can quickly set the database information and other variables in this file and have the application fully working.