Novel
Get NovelGuidesAPI Reference
Latest - 2025.1.0
Latest - 2025.1.0
  • Welcome to Novel
  • Start
  • Philosophy
  • Tech Stack
  • Releases
  • Versions
  • Changelog
  • License
  • Privacy
  • Warranty
  • Security Policy
  • Errors
    • Cannot start Novel
    • Unauthorized
    • Invalid Session
    • Validation Failed
  • Novel Server
    • Getting Started
    • Project Structure
    • With Novel Web
    • Configuration
    • Novel CLI
      • novel dev
      • novel start
      • novel new
    • Novel API
      • API Reference
    • Database
      • Caching
    • Migrations
    • Models
    • Routing
      • Route Directives
      • Middleware
      • Request Helpers
      • Schema
    • Sessions
    • Authentication
      • Passwords
      • Magic Links
      • Two-Factor Authentication
      • Forget Password
      • Email Verification
      • OAuth2 Support
    • Authorization
    • Users
    • Organizations
    • Subscriptions
    • Pricing
    • Validation
    • Mail
    • Notifications
    • API Keys
    • Events
    • Errors
    • Feature Flags
    • Uploading Files
    • Testing
    • Scheduled Cron Jobs
    • Background Jobs
    • Sockets
    • Logging
    • Telemetry
    • Deployment
  • Novel Web
    • Getting Started
    • Configuration
    • Project Structure
    • Routing
    • Layout and Styles
    • Authentication
    • Authorization
    • Requests
    • Request Files
    • Validation
    • Components
      • Button
      • Alerts
      • Copybox
      • Inline Notify
      • Input
      • Select
      • Toast
      • Toggle
      • Upload
      • Stripe Card
    • Hooks
      • useSession
      • useMobile
      • getSession
      • useFeature
      • useAuthorized
      • useNotification
      • useSocket
    • Localstorage
    • Errors
    • Internationalization (i18n)
    • Constants
    • Feature Flags
    • Testing
    • Telemetry
    • Deployment
    • Devtools (Alpha)
Powered by GitBook
On this page
  • Accept Invites
  • Quick Start
  • Work on something
  • Configuring your Instance
  • Working with the API
  • Working with Data
  • Working with the UI
  • Going to Production
  • Contributing
  • Support

Was this helpful?

Welcome to Novel

Last updated 5 months ago

Was this helpful?

🚧 Documentation is still under construction 🚧

Please send us a message in our community or email us for direct answers to questions.

Current Stable Version: 2025.1.0 (December 2024)

Thank you for purchasing Novel. We hope you find value in this software as much as we do from your purchase.

Novel is a full-stack SaaS starter kit built with Node.js, Next.js, React, PostgreSQL, and best practices that can get your team up and running as fast as possible.

Novel was built to scratch an itch on our experience of building and re-building blocks of features for different companies and sites. This is the amalgamation of those.

The product suite includes:


The documentation is split based on the layers that you will be interacting with as you develop. If you have purchased a standard license, all products should be available to you.

Accept Invites

You would have been invited to a private Discord Community and the private Github repository under https://github.com/madewithnovel. Make sure you have accepted these invites. If you have any problems, send us a message at .

Quick Start

Get up and running by running the code in your terminal

mkdir your-new-project
cd your-new-project
curl -fsSL https://novel.dev/install.sh | bash

Work on something

Configuring your Instance

Working with the API

Working with Data

Working with the UI

Going to Production


Contributing

You or your team can send over pull requests for any immediate changes you need to see in Novel. It will be reviewed according to Novel's technical direction and capabilities. You will be advised by Novel on whether PRs can be merged or if it is a custom implementation that should live in your application instead.

Support

Continue to to finish your setup.

Head over to for other useful tips.

Please abide by the provided .

If you require support and training on this software. Send us a message at and we will get back to you within 1 business day.

Novel Native

Mobile App. Coming Soon!

Novel Server

API Server

Novel Web

Open Source Next.js UI

Novel Studio

Admin Dashboard

hello@novel.dev
Discord Community
Madewithnovel Github Repository
Getting Started

How do I define my Pricing?

How can I send emails?

What configurations are available?

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?

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?

How do I make a new Page?

How do I make a request to my API?

How can I add my own styles?

How do I add shadcn/ui to my project?

How can I write tests for my UI?

Production Checklist

Deploying with AWS ECS, Fargate, and RDS

Deploying the UI with Vercel

Deploying with AWS EC2 and RDS

Deploying with a VPS

Software License
hello@novel.dev
Start | Novel
Introduction | Novel
Logo
Logo
Guides