Git Product home page Git Product logo

young-folks's Introduction

Laravel Telegram Bot Application

This Laravel-based application serves as the backend for a Telegram bot, featuring an administrative panel powered by Laravel Nova. Initially created for non-profit Young Folks Latvia

Prerequisites

Before you begin, ensure you have the following:

  • Docker and Docker Compose: The application is containerized, making it easy to build and deploy.
  • MySQL Database: The application requires a MySQL database. MariaDB is preferable. Ensure you have access to a MySQL server instance.
  • Telegram Bot API Token: You'll need to create a Telegram bot via BotFather to obtain your API token.
  • Laravel Nova License: Laravel Nova is utilized for the admin panel. A license is required for its use. Purchase and more information are available at Laravel Nova.

Installation

  1. Clone the Repository

    Start by cloning this repository to your local machine or server.

  2. Environment Configuration

    Rename the .env.example file to .env and update the environment variables, including your database credentials and Telegram Bot API token.

  3. Docker Compose

    Use Docker Compose to build and start the containers. The application will be available on port 80. Run the following command in the root directory of the project:

    docker-compose up -d
    

    Ensure your DNS record is pointing to Docker. You might want to change port, the app is working on. This app requires webhooks to be accessible for Telegram.

  4. Laravel Setup

    After the containers are up and running, execute the following commands to set up Laravel:

    docker-compose exec php-yf php artisan key:generate
    docker-compose exec php-yf php artisan migrate
    

    Create UsersTableSeeder file and adjust Permissions seeders accordingly

    docker-compose exec php-yf php artisan db:seed
    

Setting Up Laravel Nova

  1. Version

    Currently only version 4.x is supported

  2. Install Laravel Nova

    Follow the instructions provided by Laravel Nova for installation. Remember, you must have purchased a license to use Laravel Nova.

  3. Create Users and Permissions

    After setting up Laravel Nova, you will need to create users and assign them appropriate permissions. This ensures that only authorized users can access the admin panel.

Usage

Once everything is set up, your Laravel Telegram Bot application is ready to use. Access it through your web browser at http://localhost or the configured domain/IP address.

Contributing

We welcome contributions! Please feel free to ask questions, to fork the repository, make changes, and submit pull requests.

License

This application is open-source software licensed under the MIT license.


Remember to customize the instructions and information based on your specific application details and requirements.

young-folks's People

Watchers

Oleg Pashkovsky avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.