Getting Started

Your license grants you access to the https://github.com/madewithnovel/novel repository where the Novel API codebase can be cloned and installed from.

Start | Novel

Novel Web, Novel Studio, and Novel Native(Soon) all make use of the Novel API to function. You will not be able to use any of these other products without Novel API.

You can start by checking any of the guides below or searching with the documentation search box.

Configuring your Instance

How do I define my Pricing?

How can I send emails?

What configurations are available?

Working with the API

How do I create a new endpoint?

How do I secure endpoints?

How can I write my own middleware?

How do I use background jobs?

How can I set up a scheduled cron job?

How do I setup my Social Providers

How do I write tests for my features?

Working with Data

How do I create a new Table?

How do I override an existing Model?

How can I query my new tables?

How do I make updates?

How does validation work?