mittwald GPT

This is a mittwald extension with OpenAI GPT integration, generated with the mittvibes CLI tool.

Getting Started

Prerequisites

• Node.js v20.11.1 or higher
• pnpm v10.4.1 or higher
• PostgreSQL database (non-pooling connection)

Installation

1. Install dependencies:

   pnpm install

2. Set up your environment variables:

   cp .env.example .env
   # Edit .env with your actual values

3. Generate Prisma client and run migrations:

   pnpm db:generate
   pnpm db:migrate:deploy

4. Start the development server:

   pnpm dev

Your extension will be available at http://localhost:5173

Project Structure

src/
├── components/         # React components
├── hooks/             # Custom React hooks
├── middlewares/       # TanStack middleware
├── routes/            # TanStack Router routes
│   ├── api/          # API endpoints
│   └── __root.tsx    # Root layout
├── server/           # Server functions
│   └── functions/    # Server-side functions
├── client.tsx        # Client entry point
├── db.ts            # Prisma client configuration
├── env.ts           # Environment validation
├── global-middleware.ts  # Global middleware
└── router.tsx       # Router configuration

Available Scripts

• pnpm dev - Start development server
• pnpm build - Build for production
• pnpm start - Start production server
• pnpm check - Run Biome checks
• pnpm lint - Lint code
• pnpm format - Format code
• pnpm test - Run tests
• pnpm db:generate - Generate Prisma client
• pnpm db:migrate:dev - Run migrations in development
• pnpm db:migrate:deploy - Deploy migrations
• pnpm db:studio - Open Prisma Studio

Extension Setup

For Contributors

1. Configure Webhooks: Set your webhook URL in mStudio Contributor UI
2. Set Scopes: Configure required scopes and extension context
3. Configure Anchors: Point anchors to http://localhost:5173
4. Install Extension: Perform first installation via API
5. Start Development: Run pnpm dev and open your extension

Documentation

• mittwald API Documentation
• Extension Development Guide
• Frontend Fragment Anchors

Technology Stack

• Framework: TanStack Start (React-based full-stack framework)
• Database: PostgreSQL with Prisma ORM
• UI Components: mittwald Flow Remote React Components
• Authentication: mittwald Extension Bridge
• Webhooks: mitthooks library
• Code Quality: Biome (linting & formatting)
• Testing: Vitest

Contributing

This project was generated with mittvibes CLI by mittwald.

For issues with the CLI tool itself, please report them at the mittvibes repository.