mirror of
https://github.com/MODSetter/SurfSense.git
synced 2025-09-02 02:29:08 +00:00
70 lines
2.2 KiB
Text
70 lines
2.2 KiB
Text
---
|
|
title: Introduction
|
|
"og:title": "Getting started with Next-Fast-Turbo"
|
|
description: A starter project for FastAPI, Next.js and Turborepo.
|
|
---
|
|
|
|
## What is Next-Fast-Turbo?
|
|
|
|
Next-Fast-Turbo is designed as a personal starter kit for Next.js and FastAPI projects. It is a monorepo that includes a Next.js frontend and a FastAPI backend. The project is designed to be deployed to Vercel, but can be deployed to any platform that supports monorepos.
|
|
|
|
This documentation is not written to be a tutorial, but instead to be a reference for the project. It 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:
|
|
|
|
- Example 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
|
|
|
|
Next-Fast-Turbo is fully open-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**
|
|
|
|
- [Vercel](https://vercel.com/) - 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/vercel">
|
|
Deploy the monorepo to Vercel
|
|
</Card>
|
|
</CardGroup>
|