> ## Documentation Index
> Fetch the complete documentation index at: https://docs.novoyager.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> The heart of Novoyager with tooling under FastAPI, Next.js and Turborepo.

## What is Novoyager?

Convert your ideas to action plans by using novoyager, be it your initial idea or a battle tested plan of action. We'll use the SOTA models to understand you, your team and the initial requirement and build of top of that. The monorepo includes a Next.js frontend and a FastAPI backend. The project is designed to be deployed to Netlify & Porter Cloud, but can be deployed to any platform that supports monorepos.

This documentation is designed to be a living document that can be updated as the project evolves.

## Features

**Frontend**\
The Next.js application comes with a fully built frontend that includes:

* A responsive layout
* A dashboard/sidebar design
* Pre-configured connection to the backend API
* Autogenerated TypeScript types based off the FastAPI OpenAPI schema
* A variety of design components, mostly from ShadCN UI (including chart examples)

**Backend**\
The FastAPI application comes with a fully built backend that includes:

* Endpoints
* Pre-configured schema/crud operations
* Easily extensible to add more endpoints

**Documentation**\
Built using Mintlify, a fully responsive and configured documentation site that features:

* A fully built documentation site
* A variety of Mintlify components
* A fully configured mint.json

## Tech stack

Novoyager is fully close-source built using the following technologies:

**Frontend**

* [Next.js](https://nextjs.org/) - Framework for building React applications
* [Tailwind CSS](https://tailwindcss.com/) - CSS framework
* [ShadCN UI](https://ui.shadcn.com/) - UI kit

**Backend**

* [FastAPI](https://fastapi.tiangolo.com/) - Python backend API

**Documentation**

* [Mintlify](https://mintlify.io/) - Documentation

**Global**

* [Netlify](https://app.netlify.com) - FE hosting
* [Porter](https://cloud.porter.run) - BE hosting
* [Turbo](https://turbo.build/repo) - monorepo

## Getting started

<CardGroup cols={2}>
  <Card title="Local development" icon="code" href="local-development">
    Install the application locally
  </Card>

  <Card title="Deployment" icon="code-branch" href="deployment/deployment">
    Deploy the monorepo
  </Card>
</CardGroup>