Development

​

Introduction

Novel’s codebase is set up in a monorepo (via Turborepo) and is fully open-source on GitHub.

Here’s the monorepo structure:

apps
├── docs
├── web
packages
├── headless
├── tailwind-config

​

Step 1: Local setup

First, clone the Novel repo

git clone https://github.com/steven-tey/novel

Run the following command to install the dependencies:

pnpm i

Install Mintlify CLI (for docs server):

pnpm i -g mintlify

​

Step 2: Start the development server

Finally, you can start the development server. This will build the packages + start the app servers.

pnpm dev

​

Step 3: Use Generative AI Local (Optional)

You can use Ollama to run your local AI server.
https://ollama.com/blog/openai-compatibility

# You cand find the config in the web app
/api/generate/route.ts