Getting StartedΒΆ

This section gets you from zero to a running next.dj project. Read the overview to learn the mental model, then install the package. The five tutorial parts build a small Notes application from there.

Read first

Overview

The mental model behind next.dj. Read it once to understand pages, layouts, components, and actions.

Installation

Install the package, register it in Django, and serve a single page.

Build the Notes App

Building the First Page

Create the Notes application, model the data, and serve the index page.

Adding Layouts and Context

Wrap pages in a layout and share data through context.

Components and Static Assets

Extract a component and ship co-located CSS and JS.

Forms and Actions

Render forms and dispatch actions to create, edit, and delete notes.

Testing and Autoreload

Test pages end to end and use the development server.

What to Read Next

Where to go for deeper topics, recipes, and reference material.