Developer Guide
Welcome to the Aventa AI developer documentation. This guide covers everything you need to integrate with our platform or contribute to the project.
Quick Links
- API Reference - Complete API documentation
- Architecture - System design overview
- Authentication - Security implementation
- Telegram Integration - Bot and Web App integration
- Deployment - Production setup guide
Getting Started
Prerequisites
- Node.js 18+
- MongoDB 5+
- Telegram Bot Token (for bot features)
- Aventa AI API Key (for AI features)
Local Development
- Clone the repository:
bash
git clone https://github.com/aventaproject/aventa-ai-dapp.git
cd aventa-ai-dapp
- Install dependencies:
bash
# Backend
cd backend
npm install
# Frontend
cd ../frontend
npm install
- Configure environment:
bash
# Backend .env
cp .env.template .env
# Edit with your credentials
# Frontend .env.local
VITE_BACKEND_URL=http://localhost:5020
- Start development servers:
bash
# Backend (from /backend)
npm run dev
# Frontend (from /frontend)
npm run dev
Technology Stack
Backend
- Framework: Express.js
- Database: MongoDB with Mongoose ODM
- Authentication: JWT + Telegram verification
- AI Integration: Aventa AI Engine
- Real-time: Telegram Bot API
Frontend
- Framework: React 18 with Vite
- UI Library: Tailwind CSS + shadcn/ui
- State Management: React Context API
- Telegram SDK: Telegram Web App SDK
Contributing
We welcome contributions! Please see our GitHub repository for:
- Issue reporting
- Feature requests
- Pull request guidelines
- Code of conduct
Support
- Technical questions: Open a GitHub issue
- General support: Contact via Telegram community
- Bot usage: @AIAventaBot for AI generation
- Security issues: Please report privately
License
Aventa AI is proprietary software. All rights reserved.
For licensing inquiries, please contact the team via Telegram.