Giter VIP home page Giter VIP logo

schedule-bot-api's Introduction

Schedule Bot API

Серверная часть проекта бота для Slack и Telegram, который умеет отправлять сообщения по расписанию.

Фронтенд находится в другом репозитории

Связь с разработчиками — #butler_bot в Слаке Нетологии.

Технические детали

Сервер работает на express.

Основные обязанности сервера:

  • предоставление данных фронтенду проекта
  • работа с MongoDB для хранения данных
  • взаимодействие с API Slack и Telegram
  • для выполнения задач по расписанию используется Heroku Scheduler

База данных

В качестве базы данных используется MongoDB. Работа с ней происходит через официальный клиент.

В базе данных хранятся две коллекции:

  • хуки (hooks)
  • лекции (lessons)

Хуки — это уникальные эндпоинты, с помощью которых бот отправляет сообщения в определенный канал. Для каждого канала студентов есть собственный хук в MongoDB. Дополнительно там хранится так же называние группы, id и название канала.

Лекции — информация о названии, дате проведения, анонсе лекции. Сформированные на базе этой информации сообщения автоматически отправляются студентам.

Разработка

  1. Установи зависимости npm i
  2. Создай файл .env в корне проекта. Добавь в него следующие переменные:
    • MONGODB_URI — ссылка для подключения к MongoDB с данными
    • PORT — порт, на котором должен работать сервер (обычно 8080)
    • TELEGRAM_BOT_TOKEN — токен телеграм бота
  3. Запусти локальный сервер npm start

schedule-bot-api's People

Contributors

vovachebr avatar nlopin avatar

Watchers

James Cloos 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.