Giter Club home page Giter Club logo

football-chat-bot-2's Introduction

football-chat-bot-2

Football chat bot build with NestJS framework

Build Status codecov

Install

  1. Clone repository to your local filesystem from github:
git clone https://github.com/tormozz48/football-chat-bot-2.git
  1. Install npm dependencies:
npm install
  1. Set up all environment variables. Also you can create .env file and fill them with environment variables described in "Configuration" section.

  2. Launch application server:

npm start

Configuration

Configuration is performed by modifying these environment variables:

  • TELEGRAM_BOT_TOKEN - unique telegram bot token string
  • TELEGRAM_USE_PROXY - true/false. If set to true then application will establish connection with telegram server via proxy.
  • TELEGRAM_PROXY_HOST - proxy server host
  • TELEGRAM_PROXY_PORT - proxy server port
  • TELEGRAM_PROXY_LOGIN - proxy auth login
  • TELEGRAM_PROXY_PASSWORD - proxy auth password
  • VK_TOKEN - unique vk bot token string
  • DATABASE_URL - connection url fot database. Used for production environment.

Development

Configured commands:

  • npm run build - compile TypeScript source code into js distributive.
  • npm run format - perform code formatting via prettier tool.
  • npm start - run application server
  • npm start:dev - run application in "watch mode". Restart after source code chages.
  • npm start:debug - run application in both "watch" and "debug" modes.
  • npm start:prod - run application in production mode.
  • npm run lint - perform code linting via tslint tool.
  • npm test - run tests.
  • npm test:watch - run tests in "watch mode".
  • npm test:cov - run tests and calculate code coverage.

Third-party software

  • NestJS - is a framework for building efficient, scalable Node.js server-side applications.
  • TypeORM - TypeORM is an ORM that can run in NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms and can be used with TypeScript and JavaScript (ES5, ES6, ES7, ES8).
  • Telegraf - modern Telegram Bot Framework for Node.js.
  • Handlebars - Minimal templating on steroids.

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.