Skip to content
Get packs

Guide · Open source

How to use AdonisJS core: setup, structure and tips

Updated · written with AI from the project's own documentation and checked against our catalogue data

AdonisJS core (@adonisjs/core) is a TypeScript-first, full-stack MVC web framework for Node.js. It is used to build web apps and API servers, and it ships with testing support, modern tooling and an ecosystem of official packages. This guide explains what the framework is, how to get the source, and how to decide whether it fits your project.

AdonisJSadonisjs/core · ★ 19.2k · MIT

Quick start

  1. 1Check Node.js. Confirm Node.js is installed, since it is the listed prerequisite.
  2. 2Clone the repository. Run the clone command from the README to get the adonisjs/core source.
  3. 3Read the guides. Open docs.adonisjs.com to follow the official setup for a new application.
  4. 4Learn the MVC layout. Review how models, views and controllers are organised in the framework.
  5. 5Use TypeScript. Write application code in TypeScript, as the framework is TypeScript-first.
  6. 6Add official packages. Pick from the official ecosystem packages that are designed to work together.

What AdonisJS core is and who it is for

AdonisJS describes itself as a fullstack web framework focused on ergonomics and speed. Its README says it takes care of much of the common web development work and offers a clean, stable API for building web apps and microservices.

It suits developers who want a structured, batteries-included framework on Node.js, and teams building API servers who want an opinionated MVC layout. It is a poor fit for people with no JavaScript or Node.js experience, since it assumes familiarity with TypeScript and MVC concepts, and for people who prefer small libraries they assemble themselves.

  • Good fit: TypeScript developers building full-stack apps
  • Good fit: teams that want official packages that work together
  • Poor fit: beginners without JavaScript or Node.js experience
  • Poor fit: developers who want minimal libraries they assemble themselves

What you need before you start

The source lists Node.js as the prerequisite. Install method is through a package manager. The README also documents the framework's TypeScript focus, so expect to write your application code in TypeScript.

The README does not list specific Node.js versions in the text provided, so check the official guides at docs.adonisjs.com for current requirements.

  • Node.js
  • A package manager
  • Working knowledge of TypeScript and MVC concepts

Get the adonisjs/core source

The README's install instruction is to clone the repository from GitHub. This gives you the framework source code for inspection or local work.

For building an application, the official guides at docs.adonisjs.com cover project setup in more detail than the README excerpt.

git clone https://github.com/adonisjs/core

Understand the MVC structure and included tools

AdonisJS is a full-stack MVC framework, so it organises an app around models, views and controllers. The framework includes support for testing and modern tooling, plus official packages that are designed to work together.

Because the layout is opinionated, you spend less time choosing libraries but more time learning the framework's conventions.

  • MVC architecture for web apps and API servers
  • Built-in testing support
  • Ecosystem of official packages
  • TypeScript-first development

Use the official guides and packages

The README links to three resources: the website at adonisjs.com, the guides at docs.adonisjs.com, and the contributing guide on GitHub. Use the guides as the main reference for building applications, since the README is short.

The package is published on npm as @adonisjs/core, and the project is released under the MIT licence.

  • Website: adonisjs.com
  • Guides: docs.adonisjs.com
  • Contributing: CONTRIBUTING.md in the adonisjs/.github repository
  • Licence: MIT (see LICENSE.md)

What people use it for

  • Building a full-stack web app with server-rendered pages
  • Building an API server with an opinionated MVC layout
  • Building microservices that share a consistent API
  • Running tests with the framework's built-in testing support

Frequently asked questions

Is AdonisJS free to use?

Yes. The adonisjs/core project is released under the MIT licence, which allows free use. Check the LICENSE.md file in the repository for the full terms.

What do I need to install AdonisJS?

The listed prerequisite is Node.js. The README says the framework is TypeScript-first, so familiarity with TypeScript is also expected.

How do I download AdonisJS core?

The README instructs you to clone the repository with git clone https://github.com/adonisjs/core. The official guides at docs.adonisjs.com cover building a new application.

Is AdonisJS good for beginners?

Not really. The framework assumes familiarity with JavaScript, Node.js, TypeScript and MVC concepts. Beginners may want to learn those basics first.

How does AdonisJS compare to Express or NestJS?

Express is a smaller, minimal library you assemble yourself. AdonisJS is a full-stack MVC framework with a larger opinionated structure. NestJS, Fastify and Next.js are also comparable projects, so pick based on how much structure you want.

Does AdonisJS support testing?

Yes. The README says the framework comes with support for testing, along with modern tooling and an ecosystem of official packages.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

AdonisJS core suits TypeScript developers and teams who want a structured, full-stack MVC framework on Node.js with official packages that work together. If you are new to JavaScript or prefer small libraries you assemble yourself, pick a minimal option such as Express or Fastify instead.

Install options & downloads