Introduction

Welcome to AdonisJS!

This is the official documentation website for the framework. We have divided the documentation into multiple groups, each trying to address a specific use case or audience.

Please read the AdonisJS at a glance document if you are unsure whether AdonisJS will fit your needs or match the programming style.

TypeScript usage

AdonisJS is a backend framework for Node.js. The framework is written in TypeScript, and the application you will create using AdonisJS is also going to be in TypeScript.

We are very particular about how we leverage TypeScript and maintain a good balance between the static type safety and the visual noise.

If you have never used TypeScript, we recommend learning the basics of the language first and then using AdonisJS.

Familiarity with Node.js

We also expect you to be familiar with the Node.js ecosystem and asynchronous programming in general. Suppose you are coming from a threaded language like PHP or Ruby. In that case, we recommend educating yourself with the Node.js event loop and understand how it is different from a threaded environment.

Guides

The technical guides are the in-depth documentation of the framework and cover every single topic and feature of the framework.

The guides also have documentation for the official packages of AdonisJS, i.e., Lucid ORM, template engine, Redis, and so on.

Reference

Modules with larger API surfaces like Database and Validator are also documented inside the reference guides.

Fitting all the validation rules, the database query builder methods within guides will overcrowd them, and hence they are moved to the reference guides.

Cookbooks

Cookbooks are actionable guides to help you achieve a practical task. Also, feel free to contribute to cookbooks by sending a PR.

Awesome list

A Github repository holding a curated list of awesome AdonisJS packages, articles, meetups and other resources created by the community members.

Feel free to explore and find the packages you need or submit your work to the list.

Editor extensions

Editors with support for TypeScript are all you need to work with your AdonisJS applications. However, the following is the list of extensions to enhance your developer experience.

We are looking for contributors to add support for edge template syntax to other editors as well. Here is an extensive syntax guide to test your integration.