GitHub

Introduction

Getting Started

npm (scoped)

Radonis is a full-stack application framework for building monolithic applications with a modern, React-based frontend stack. Radonis is built on top of the Node.js MVC framework AdonisJS and extends it with features for server-side rendering and client-side hydration.

Installation

Learn how to add Radonis to your AdonisJS application.

Compiler

Learn more about the built-in compiler.

Views

Learn more about views.

Components and Islands

Learn more about components and islands.


Features

  • Renders React views directly from AdonisJS routes and controllers.
  • Partially hydrates only the components that require interactivity on the client (Islands Architecture).
  • Includes pre-made hooks for working with AdonisJS inside your React views, both on client and server.
  • Ships with a compiler powered by esbuild, no Webpack Encore required.

Quick start

Just want to get started? A few steps are required, even potentially some manual setup, but don't let that scare you.

Before you start

It's strongly recommended to set up Radonis in a fresh AdonisJS project created with the web project structure. If that's not what you plan to do, make sure to first push unstaged changes to your version control system.

Installing Radonis packages

Install the two Radonis core packages.

npm install --save @microeinhundert/radonis @microeinhundert/radonis-server

Note

AdonisJS 5 is required.

Configuring the server provider

Before Radonis can do its thing and hook into the AdonisJS lifecycle, you must register the Radonis service provider with your AdonisJS application.

node ace configure @microeinhundert/radonis-server

Configuring the required AdonisJS addons

Radonis requires the two official AdonisJS addons @adonisjs/i18n and @adonisjs/session to be installed and configured. Execute the following commands and follow the instructions output to the terminal.

node ace configure @adonisjs/i18n

and

node ace configure @adonisjs/session

Note

The two required addons were automatically installed in your projects package.json as part of the server provider configuration. Just the configuration command of the two addons is required to be run manually.


Plugins

UnoCSS

Add styling powered by UnoCSS to your Radonis application.