ShipFastAI
Documentation

Build faster with our comprehensive docs

Everything you need to get started, from installation to production deployment.

Quick Links

Getting Started

Install and run Shipfastai in under 5 minutes

Backend Setup

Configure FastAPI, database, and API routes

Frontend Setup

Next.js configuration and component library

Authentication

JWT, OAuth, and user management

Database

PostgreSQL, migrations, and ORM patterns

AI Integration

LLM providers, RAG, and embeddings

Getting Started

Prerequisites

  • Python 3.10+
  • Node.js 18+
  • PostgreSQL 14+
  • Redis (optional, for caching)

Quick Start

# Clone the repository
git clone https://github.com/your-org/Shipfastai.git
# Install backend dependencies
cd backend && pip install -r requirements.txt
# Install frontend dependencies
cd ../frontend && npm install
# Start development servers
npm run dev

Project Structure

Shipfastai/
├── backend/
├── app/
├── api/ # API routes
├── core/ # Config, security
├── models/ # SQLAlchemy models
├── services/ # Business logic
└── ai/ # LLM & RAG
├── frontend/
├── src/app/ # Next.js pages
├── src/components/
└── src/lib/ # Utilities
├── infrastructure/
└── terraform/ # IaC configs

API Reference

GET/api/v1/users/me

Get the current authenticated user's profile

POST/api/v1/chat/completions

Send a message to the AI and receive a streaming response

PUT/api/v1/documents/{id}

Update a document in the RAG knowledge base

Need help?

Join our Discord community for support and discussions with other developers.

Join Discord