# Welcome to Novel

{% hint style="danger" %}
🚧 **Documentation is still under construction** 🚧

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

{% hint style="info" %}
Current Stable Version: **2025.1.0** (December 2024)
{% endhint %}

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:

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td><h3>Novel Server</h3></td><td>API Server</td><td><a href="novel-server/getting-started">getting-started</a></td></tr><tr><td></td><td><h3>Novel Web</h3></td><td>Open Source Next.js UI</td><td><a href="novel-web/getting-started">getting-started</a></td></tr><tr><td><p></p><h3>Novel Studio</h3></td><td>Admin Dashboard</td><td></td><td><a href="novel-studio/getting-started">getting-started</a></td></tr><tr><td></td><td><h3>Novel Native</h3></td><td>Mobile App. <em>Coming Soon!</em></td><td></td></tr></tbody></table>

***

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 <hello@novel.dev>.

* [ ] [Discord Community](https://discord.com/channels/889773464809000970)
* [ ] [Madewithnovel Github Repository](https://github.com/madewithnovel)

## Quick Start

Get up and running by running the code in your terminal

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

Continue to [Getting Started](https://docs.novel.dev/start) to finish your setup.

{% embed url="<https://docs.novel.dev/start>" %}

## Work on something

Head over to [Guides](https://app.gitbook.com/o/-LZ3BF5qGujSORLjFmRZ/s/J8pswmvPJ01KHGsmScic/ "mention") for other useful tips.

{% embed url="<https://docs.novel.dev/guides>" %}

### Configuring your Instance

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>How do I define my Pricing?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/configuring-pricing">https://docs.novel.dev/guides/knowledge-base/novel-server/configuring-pricing</a></td></tr><tr><td>How can I send emails?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/sending-emails">https://docs.novel.dev/guides/knowledge-base/novel-server/sending-emails</a></td></tr><tr><td>What configurations are available?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/configuring-novel">https://docs.novel.dev/guides/knowledge-base/novel-server/configuring-novel</a></td></tr></tbody></table>

### Working with the API

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>How do I create a new endpoint?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/creating-a-rest-endpoint">https://docs.novel.dev/guides/knowledge-base/novel-server/creating-a-rest-endpoint</a></td></tr><tr><td>How do I secure endpoints?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/securing-an-endpoint">https://docs.novel.dev/guides/knowledge-base/novel-server/securing-an-endpoint</a></td></tr><tr><td>How can I write my own middleware?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/writing-a-middleware">https://docs.novel.dev/guides/knowledge-base/novel-server/writing-a-middleware</a></td></tr><tr><td>How do I use background jobs?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/background-jobs">https://docs.novel.dev/guides/knowledge-base/novel-server/background-jobs</a></td></tr><tr><td>How can I set up a scheduled cron job?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/cron-jobs">https://docs.novel.dev/guides/knowledge-base/novel-server/cron-jobs</a></td></tr><tr><td>How do I setup my Social Providers</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/setting-up-oauth">https://docs.novel.dev/guides/knowledge-base/novel-server/setting-up-oauth</a></td></tr><tr><td>How do I write tests for my features?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/writing-end-to-end-tests">https://docs.novel.dev/guides/knowledge-base/novel-server/writing-end-to-end-tests</a></td></tr></tbody></table>

### Working with Data

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>How do I create a new Table?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/database/creating-a-table">https://docs.novel.dev/guides/knowledge-base/database/creating-a-table</a></td></tr><tr><td>How do I override an existing Model?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-server/overriding-a-model">https://docs.novel.dev/guides/knowledge-base/novel-server/overriding-a-model</a></td></tr><tr><td>How can I query my new tables? </td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/database/writing-queries">https://docs.novel.dev/guides/knowledge-base/database/writing-queries</a></td></tr><tr><td>How do I make updates?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/database/writing-mutations-updates-deletes">https://docs.novel.dev/guides/knowledge-base/database/writing-mutations-updates-deletes</a></td></tr><tr><td>How does validation work?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/database/using-validations">https://docs.novel.dev/guides/knowledge-base/database/using-validations</a></td></tr></tbody></table>

### Working with the UI

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>How do I make a new Page?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/creating-a-marketing-page">https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/creating-a-marketing-page</a></td></tr><tr><td>How do I make a request to my API?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/making-a-request-to-the-api">https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/making-a-request-to-the-api</a></td></tr><tr><td>How can I add my own styles?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/applying-styles">https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/applying-styles</a></td></tr><tr><td>How do I add shadcn/ui to my project?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/using-shadcn-ui">https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/using-shadcn-ui</a></td></tr><tr><td>How can I write tests for my UI?</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/writing-tests-with-playwright">https://docs.novel.dev/guides/knowledge-base/novel-web-next.js/writing-tests-with-playwright</a></td></tr></tbody></table>

### Going to Production

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Production Checklist</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/production-checklist">https://docs.novel.dev/guides/production-checklist</a></td></tr><tr><td>Deploying with AWS ECS, Fargate, and RDS</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/deployment/deploying-to-aws-ecs-fargate-and-rds">https://docs.novel.dev/guides/deployment/deploying-to-aws-ecs-fargate-and-rds</a></td></tr><tr><td>Deploying the UI with Vercel</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/deployment/deploying-novel-web-to-vercel">https://docs.novel.dev/guides/deployment/deploying-novel-web-to-vercel</a></td></tr><tr><td>Deploying with AWS EC2 and RDS</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/deployment/deploying-to-aws-ec2-and-rds">https://docs.novel.dev/guides/deployment/deploying-to-aws-ec2-and-rds</a></td></tr><tr><td>Deploying with a VPS</td><td></td><td></td><td><a href="https://docs.novel.dev/guides/deployment/deploying-to-digital-ocean">https://docs.novel.dev/guides/deployment/deploying-to-digital-ocean</a></td></tr></tbody></table>

***

## 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.

Please abide by the provided [Software License](https://novel.dev/legal/license).

## Support

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