Getting Started

How do I install Underpeaks Core?

Step-by-step installation guide for Underpeaks Core.

Which database should I use?

Comparing the five supported database adapters.

What is Underpeaks?

An overview of Underpeaks and what it does.

How do I attach a model to a page?

How to make a model browsable by attaching it to a page.

What is the nxf CLI and how do I install it?

How to install the Underpeaks CLI globally with npm.

How do I log in with the CLI?

nxf login opens a browser-based sign-in flow.

What does nxf doctor do?

A diagnostic check to run before generating your app.

How do I switch between projects with the CLI?

Use nxf project list and nxf project switch to change active projects.

What's the difference between Underpeaks Studio and Underpeaks Core?

Studio is hosted by us; Core is self-hosted and free.

How do I create my first model?

Step-by-step guide to creating your first content model.