create-gentiq-app 0.7.6 → 0.7.8

package/README.md

@@ -0,0 +1,96 @@
+# create-gentiq-app 🚀
+
+The official CLI for bootstrapping **Gentiq** applications. Kickstart your agentic chatbot in seconds.
+
+## Quick Start
+
+The fastest way to get started with Gentiq is to run the following command in your terminal:
+
+```bash
+npx create-gentiq-app@latest my-awesome-ai
+```
+
+Or with **Yarn**:
+
+```bash
+yarn create gentiq-app my-awesome-ai
+```
+
+Or with **PNPM**:
+
+```bash
+pnpm create gentiq-app my-awesome-ai
+```
+
+---
+
+## What is Gentiq?
+
+**Gentiq** is a world-class AI agent framework designed for building production-ready, conversational applications. It combines the power of **PydanticAI** on the backend with a high-performance **React** frontend, providing everything you need out-of-the-box.
+
+### Features Scaffolded:
+- ⚡ **AI Streaming**: Real-time agent responses via PydanticAI and Vercel AI SDK.
+- 🛠️ **Admin Dashboard**: Built-in analytics, history logs, and user management.
+- 💰 **Atomic Balance**: Native tracking and enforcement of per-user token and request limits.
+- 📂 **Flexible Persistence**: Integrated MinIO/S3 for file storage and MongoDB for state.
+- 🔒 **Enterprise-Grade Security**: Full JWT authentication suite and encrypted sessions.
+
+---
+
+## Project Structure
+
+When you initialize a new app, the CLI generates a modern, monorepo-friendly structure:
+
+```text
+my-awesome-ai/
+├── backend/            # FastAPI + PydanticAI application
+│   ├── main.py         # App entry point
+│   └── pyproject.toml  # Python dependencies (UV managed)
+├── frontend/           # Vite + React application
+│   ├── src/            # UI components and hooks
+│   └── package.json    # Frontend dependencies
+├── .env.example        # Environment variable template
+└── README.md           # Your project documentation
+```
+
+---
+
+## Local Development
+
+Once your project is scaffolded, follow these steps to get running:
+
+### 1. Environment Setup
+Copy the example environment file and add your API keys and modify other variables as desired:
+```bash
+cp .env.example .env
+```
+
+### 2. Launch Backend
+The backend uses `uv` for lightning-fast Python package management.
+```bash
+cd backend
+uv sync
+uv run uvicorn main:app.api --reload --port 8000
+```
+
+### 3. Launch Frontend
+```bash
+cd frontend
+npm install
+npm run dev
+```
+
+Your app is now live at `http://localhost:5173`!
+
+---
+
+## Why Gentiq?
+
+Unlike generic boilerplates, Gentiq is built with **developer velocity** and **production scalability** in mind. It provides the "boring" parts of AI development—authentication, rate limiting, and persistence—so you can focus on building your agents.
+
+- **Type-Safe**: End-to-end TypeScript and Python (Pydantic) types.
+- **Customizable**: Every part of the UI and Backend is modular and extensible.
+- **Modern Stack**: React 19, FastAPI, PydanticAI, and TailwindCSS.
+
+---
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-gentiq-app",
-  "version": "0.7.6",
+  "version": "0.7.8",
   "description": "CLI to scaffold a new Gentiq application",
   "type": "module",
   "bin": {

package/templates/starter/.env.example

@@ -0,0 +1,10 @@
+APP_NAME=gentiq-app
+OPENAI_API_KEY=sk-proj-...
+LOGFIRE_API_KEY=pylf_...
+LOGFIRE_TOKEN=pylf_...
+BACKEND_URL=http://localhost:8000
+JWT_SECRET_KEY=deveopment_jwt_key
+JWT_EXPIRATION_HOURS=720
+ADMIN_JWT_SECRET_KEY=development_admin_jwt_key
+ADMIN_JWT_EXPIRATION_HOURS=1440
+BACKEND_API_KEY=development_api_key

package/templates/starter/README.md

@@ -1,72 +1,80 @@
-# Gentiq Default Template Application
+# 🚀 Gentiq AI Application
 
-**Location:** `/templates/default`
+This is a production-ready conversational AI application built with the [Gentiq Framework](https://github.com/arxyzan/gentiq). It features a high-performance Python backend and a modern React frontend, providing everything you need to build world-class AI agents out of the box.
 
-A world-class conversational AI scaffold built fully on the Gentiq Framework. This template serves as a complete, reference-ready application ready for extension and branding.
+## ✨ Key Features
 
-## Quick Start (Minimal Environment)
+- **⚡ Real-time AI Streaming**: Powered by PydanticAI and Vercel AI SDK for buttery-smooth streaming responses.
+- **🛠️ Integrated Admin Panel**: Built-in dashboard for monitoring user history, analytics, and system state.
+- **💰 Atomic Balance Tracking**: Native enforcement of per-user token and request limits.
+- **📂 Robust Persistence**: Pre-configured support for MongoDB (state) and MinIO/S3 (attachments).
+- **🔒 Secure by Default**: Full JWT authentication suite with role-based access control.
 
-1. **Copy Environment**: Copy `.env.example` to `.env` in the project root and fill in your values (MongoDB, MinIO, AI Providers).
-2. **Setup Backend**:
+---
 
-    ```bash
-    cd templates/default/backend && uv sync
-    ```
+## 🛠️ Getting Started
 
-3. **Run Backend**:
+Follow these steps to get your development environment up and running.
 
-    ```bash
-    uv run uvicorn main:app.api --reload --port 8000
-    ```
+### 1. Prerequisites
+- **Python 3.12+** (Recommended: [uv](https://github.com/astral-sh/uv))
+- **Node.js 18+** (Recommended: [pnpm](https://pnpm.io/))
+- **Docker** (for running MongoDB/MinIO locally)
 
-4. **Setup Frontend**:
-
-    ```bash
-    cd templates/default/frontend && npm install
-    ```
+### 2. Environment Setup
+Copy the example environment file to your project root and fill in your API keys:
+```bash
+cp .env.example .env
+```
 
-5. **Run Frontend**:
+### 3. Launch the Backend
+The backend manages your AI agents and data persistence.
+```bash
+cd backend
+uv sync
+uv run uvicorn main:app.api --reload --port 8000
+```
 
-    ```bash
-    npm run dev
-    ```
+### 4. Launch the Frontend
+The frontend provides a premium chat interface and admin dashboard.
+```bash
+cd frontend
+npm install
+npm run dev
+```
+Navigate to `http://localhost:5173` to see your app in action!
 
-## Development
+---
 
-The template app is configured to pull in core functionality from the local `packages/` directory for real-time development.
+## 📁 Project Structure
 
-### Backend Entrypoint (`templates/default/backend/main.py`)
+```text
+├── backend/            # FastAPI + PydanticAI application
+│   ├── main.py         # Backend entry point & agent definitions
+│   └── pyproject.toml  # Python dependencies (UV managed)
+├── frontend/           # Vite + React application
+│   ├── src/            # Components, hooks, and UI logic
+│   └── package.json    # Frontend dependencies
+├── .env.example        # Template for environment variables
+└── README.md           # You are here!
+```
 
-Our backend leverages the `GentiqApp` factory to dynamically spin-up the core server logic.
+---
 
-```python
-from gentiq import GentiqApp
+## 🚀 Deployment
 
-app = GentiqApp()
-api = app.api # The FastAPI instance
-```
+Gentiq is designed to be easily containerized and deployed. The recommended approach is to use Docker for both the backend and frontend components.
 
-### Frontend Entrypoint (`templates/default/frontend/src/App.tsx`)
+- **Frontend**: Build as a static site or host on Vercel/Netlify.
+- **Backend**: Deploy as a FastAPI service on AWS/GCP/Railway.
 
-The frontend is a lightweight Vite application that exports UI instances from the `gentiq` React package.
+---
 
-```tsx
-import { GentiqProvider, ChatUI, AdminPanel } from 'gentiq'
-import 'gentiq/style.css'
+## 📖 Learn More
 
-export default function App() {
-  return (
-    <GentiqProvider>
-      {/* ... routes ... */}
-    </GentiqProvider>
-  )
-}
-```
+- [Gentiq Documentation](https://github.com/arxyzan/gentiq) - Deep dive into agents and architecture.
+- [PydanticAI Docs](https://ai.pydantic.dev/) - Learn how to build type-safe agents.
 
-## Features Included (Out-of-the-Box)
+---
 
-- **AI Streaming**: Real-time agent streaming via PydanticAI and Vercel SDK.
-- **Admin Dashboard**: Comprehensive user analytics, history logs, and permissioning system.
-- **Atomic Balance**: Integrated tracking and enforcement of per-user token and request limits.
-- **MinIO/S3 Persistence**: Robust file storage for chat attachments and assistant multimodal context.
-- **JWT Security Suite**: Encrypted user and administrative authentication flows.
+*Generated with [create-gentiq-app](https://github.com/arxyzan/gentiq/tree/main/packages/cli)*