Telegram Monetization Tool

Overview

The Telegram Monetization Tool is a full-stack SaaS platform designed to help users monetize their Telegram channels and bots. This project utilizes a modern tech stack, including Next.js for the frontend and Express.js for the backend.

Tech Stack

• Frontend:

  • Next.js 14 with App Router
  • Tailwind CSS
  • shadcn/ui components
  • Redux Toolkit
  • Socket.io Client
  • TypeScript
  • React Query
  • Clerk Authentication

• Backend:

  • Node.js & Express.js
  • Prisma ORM
  • Socket.io
  • Telegram Bot API
  • Bull Queue
  • Clerk SDK
  • Zod validation

• Infrastructure:

  • PostgreSQL
  • Redis
  • Docker setup

Development Phases

1. Initial Setup & Credentials (Completed)

   • PostgreSQL Installation & Setup
   • Prisma Initial Setup
   • Clerk Authentication Setup
   • Environment Configuration
   • Git Repository Setup

2. Infrastructure & Debug Setup (Completed)

   • Docker Configuration
   • Debug & Development Environment
   • Redis Setup

3. Core Backend Development (Completed)

   • Express.js Server Setup
   • Database Models & Migrations
   • Clerk Authentication Integration
   • Telegram Bot Integration
   • Basic API Endpoints
   • Core Service Layer

4. Frontend Foundation (Completed)

   • Next.js Project Setup
   • Admin Dashboard Template
   • Core Components (Card, Layout)
   • Basic Pages (Dashboard, Channels, Settings)
   • Clerk Auth UI Integration

5. Advanced Features (Pending)

   • API Integration
   • State Management
   • Payment Integration
   • Realtime Features
   • Analytics Dashboard
   • Subscription Management
   • Notification System

6. Production Preparation (Pending)

   • Performance Optimization
   • Security Hardening
   • Testing Suite
   • Deployment Pipeline
   • Documentation

API Endpoints

• /api/user/profile: Get user profile (protected)
• /api/user/settings: Update user settings (protected)
• /api/telegram/webhook: Webhook for Telegram updates
• /api/telegram/send: Send message via Telegram bot (protected)

Frontend Pages

• /dashboard: Main dashboard overview
• /dashboard/channels: Manage Telegram channels
• /dashboard/settings: User and account settings

Getting Started

Backend Setup

1. Clone the repository:

   git clone https://github.com/cemakgun/Telegram-Monetization-Tool.git

2. Navigate to the project directory:

   cd Telegram-Monetization-Tool

3. Install backend dependencies:

   cd backend
   npm install

4. Install frontend dependencies:

   cd frontend
   npm install

5. Set up the environment variables in the .env file.

6. Run the backend server:

   cd backend
   npm run dev

7. Run the frontend server:

   cd frontend
   npm run dev

8. Access the application at http://localhost:3000.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

This project is licensed under the MIT License.