https://github.com/vchet/library-bot

Self-hosted Telegram бот для менеджмента офисной библиотеки
https://github.com/vchet/library-bot

telegram-bot

Last synced: 24 days ago
JSON representation

Self-hosted Telegram бот для менеджмента офисной библиотеки

• Host: GitHub
• URL: https://github.com/vchet/library-bot
• Owner: VChet
• License: mit
• Created: 2019-12-28T16:29:45.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-01T17:52:55.000Z (over 3 years ago)
• Last Synced: 2023-03-05T11:43:34.491Z (over 1 year ago)
• Topics: telegram-bot
• Language: JavaScript
• Homepage:
• Size: 182 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Library Bot

[![version](https://img.shields.io/github/tag/VChet/library-bot.svg?label=version)](https://github.com/VChet/library-bot/tags)

[![dep](https://img.shields.io/david/VChet/library-bot.svg?style=flat)](https://david-dm.org/VChet/library-bot)

[![devDep](https://img.shields.io/david/dev/VChet/library-bot.svg?label=devDependencies)](https://david-dm.org/VChet/library-bot?type=dev)

[![CC](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)

Uses Node.js, MongoDB, Telegraf.js

## Features

* Book borrowing/returning

* List of book borrowers

* List of available/taken books

* Search by book name/author

* User validation (requires account approval by another user)

* Book editing (add new, edit, archive)

* List of categories with a book count

* Books import from excel file

* Inline-mode: book search and its current status

## Usage

1. Clone repository

1. Install [Node.js](https://nodejs.org/en/download/package-manager/)

1. Install all dependencies `npm install`

1. Copy `.env.template`, rename it to `.env` and configure.

    ```sh

    cp .env.template .env

    ```

1. Connect to database (skip if using remote DB)

    * Install [mongoDB](https://www.mongodb.com/download-center/community)

    * Start database `mongod`

1. Start bot `npm start`