Local Setup

Proxed.AI is a monorepo that uses TurboRepo.

Project Structure

apps
├── api
├── app
├── docs
├── web
packages
├── analytics
├── jobs
├── kv
├── location
├── logger
├── mail
├── notifications
├── structure
├── supabase
├── ui
├── utils
tooling
├── typescript

The apps directory contains the core applications and services that need to be run.

• api: The core API proxy service built with Hono on Bun.
• app: The Next.js portal that is used to manage the Proxed.AI platform.
• docs: The documentation site that is built with Fumadocs.
• web: The Next.js marketing site.

The packages directory contains the shared code that is used across the project.

• analytics: The analytics service that is built with Openpanel.
• jobs: Background jobs powered by Trigger.dev.
• kv: Key-value storage utilities.
• location: The location specific utilities.
• logger: The logger service that is built with Pino.
• mail: The mail service that is built with Resend.
• notifications: Notification helpers and integrations.
• structure: The visual schema builder.
• supabase: Supabase client, queries, and database config.
• ui: The UI components that are built with Shadcn/UI.
• utils: The utility functions that are used across the project.

The tooling directory contains the tools and scripts that are used to build and run the project.

• typescript: The TypeScript configuration.

Prerequisites

• Bun
• Docker
• Supabase

Setup Steps

1. Clone the repository

git clone https://github.com/nech-ai/proxed.git

2. Install dependencies

bun install

3. Create a .env file in the root of the project

cp .env.example .env

4. Run the project

bun dev