# RamAi Project Context

This file serves as a lightweight knowledge base and project overview for AI coding agents to quickly understand the workspace structure, tech stack, and goals, saving context window tokens.

---

## 📋 Project Overview

**RamAi** is a web application and Telegram bot integration platform designed to serve the engineering, architecture, and computer graphics (CG) community. Originally established as a bot service, it provides a variety of features:
- **Interactive Menu & Category Navigation:** Structured folders/files, academy courses, civil and structural engineering files, architectural assets, and object/material libraries.
- **Academy/Education & Archive:** Providing tutorials, instruction, and educational materials.
- **Telegram Bot Integration:** Fully integrated bot interaction allowing users to search content, handle subscriptions, and receive files directly through the bot.
- **Payment & Subscriptions:** Supporting payments via Telegram Stars, Zarinpal (Iranian payment gateway), and Cryptopay.
- **Admin Dashboard:** Admin panel to manage users, upload contents (folders/files), and run broadcast messaging.

---

## 🛠 Tech Stack

- **Backend Framework:** Laravel (PHP ^8.3, Framework ^13.8)
- **Database:** MySQL / SQLite
- **Frontend Assets:** JavaScript, Vite, CSS (Blade Views)
- **APIs & Integrations:**
  - **Telegram Bot API:** Custom Telegram client service with keyboards and handlers.
  - **Payment Gateways:** Telegram Stars, Zarinpal, CryptoPay.
  - **AI Integrations:** OpenAI/OpenRouter (NVIDIA Nemotron, Gemini Embedding model).
- **Tooling:** Composer, NPM, PHPUnit.

---

## 📁 Directory Structure

Below is a high-level visualization of the project structure:

```text
RamAi/
├── app/                      # Core PHP application logic
│   ├── Http/                 # Controllers, Middleware, Requests
│   │   └── Controllers/      # App controllers (Academy, Admin, Store, Payments)
│   ├── Models/               # Eloquent Database Models
│   ├── Providers/            # Application Service Providers
│   └── Services/             # Custom integrations and business logic
│       ├── Payments/         # Payment gateways (Zarinpal, CryptoPay)
│       └── Telegram/         # Telegram API client, keyboards, and message handlers
├── bootstrap/                # Laravel bootstrap and cache configs
├── config/                   # Configuration files (database, services, app, etc.)
├── database/                 # Migrations, seeders, and factories
├── public/                   # Publicly accessible assets and entry points
├── resources/                # Front-end assets (Blade views, CSS, JS)
│   ├── views/                # Blade templating pages (admin, academy, store)
│   └── css/ & js/            # UI style and script resources
├── routes/                   # Routing definitions
│   ├── web.php               # Web panel and administrative routes
│   └── api.php               # API endpoints (e.g. webhooks, status checks)
├── tests/                    # PHPUnit testing suites
├── .env                      # Local environment configuration file
├── composer.json             # PHP dependencies and script configurations
├── package.json              # NPM front-end dependencies
└── vite.config.js            # Vite asset compilation configuration
```

---

## 🎯 Current Status & Goals

1. **Google Cloud SDK Configured:** 
   - Google Cloud SDK is set up and authenticated on the system, enabling cloud services integration, asset storage, or server management.
2. **Core Actions & Roadmap:**
   - Maintain stability of the Telegram Webhook and APIs.
   - Refine and optimize payment callbacks (Zarinpal, Stars, CryptoPay).
   - Maintain the Admin Dashboard for user management and broadcasting updates.
   - Continue building the interactive education/academy module.