foxdevuz/ngap

A telegram bot admin panel

dev-main 2025-01-19 05:42 UTC

Requires

• php: ^8.2
• laravel/framework: ^11.9
• laravel/sanctum: ^4.0
• laravel/tinker: ^2.9
• nutgram/laravel: ^1.4

Requires (Dev)

• fakerphp/faker: ^1.23
• laravel/pint: ^1.13
• laravel/sail: ^1.26
• mockery/mockery: ^1.6
• nunomaduro/collision: ^8.0
• phpunit/phpunit: ^11.0.1

MIT

• framework
• admin
• panel
• bot
• laravel
• telegram

README

About Project

This project is an admin panel for controlling Telegram bots using Laravel and Nutgram. It leverages the power of Laravel for backend operations and Nutgram for handling Telegram bot interactions.

Key Features

• Admin Panel: Provides an interface for managing Telegram bots.
• User Management: Allows administrators to manage users and their permissions.
• Statistics: Displays various statistics related to bot usage.
• Ads Management: Enables sending advertisements through the bot.
• Channel Management: Facilitates the management of Telegram channels.

Technologies Used

• PHP: The core programming language used for backend development.
• Laravel: A PHP framework used for building the web application.
• Nutgram: A PHP library for creating Telegram bots.

Installation

1. Create as project:

   composer create-project --stability=dev foxdevuz/ngap    
   cd ./ngap

2. Run database migrations:

   php artisan migrate

3. Start the development server on local:

   php artisan nutgram:run

Usage

• Admin Commands: Use the /admin command to access the admin panel.
• Statistics: Use the stats command to view bot statistics.
• Send Ads: Use the send_ad command to send advertisements.
• Manage Admins: Use the manage_admin command to manage administrators.
• Manage Channels: Use the manage_channels command to manage Telegram channels.
• Start Command: Use the start command to initiate the bot.
• Since it uses localization you will see the commands in /lang directory.

Environment Variables

• APP_NAME: The name of the application.
• APP_ENV: The application environment (e.g., local, production).
• APP_KEY: The application key.
• APP_DEBUG: Enable or disable debug mode.
• DB_CONNECTION: The database connection type.
• DB_HOST: The database host.
• DB_PORT: The database port.
• DB_DATABASE: The database name.
• DB_USERNAME: The database username.
• DB_PASSWORD: The database password.
• TELEGRAM_TOKEN: The token for the Telegram bot.
• MAIN_ADMIN_ID: The Telegram ID of the main admin.
• DEV_TELEGRAM: The Telegram username of the developer.

Contributing

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.