Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 2.29 KB

README.md

File metadata and controls

34 lines (23 loc) · 2.29 KB

Janko.js

Progressive Node.js Framework to build efficient and scalable Telegram Bot applications.

npm NPM npm

⚠️ ALPHA STATUS DISCLAIMER

This project is my first open source project and is in active development stage as well -- please be patient -- @tryvols

Description

Janko (Janko.js) is a framework for building efficient, scalable Telegram Bot applications. It uses Typescript and combines best practices from OOP (Object Oriented Programming) and FP (Functional Programming).

Under the hood, Janko makes use of Node.js Telegram Bot API library.

Janko provides a level of abstraction above this common Telegram Bot API library, but also expose it's api directly to the developer. This gives developers awesome flexibility and the feedom in using all it's possibilities.

Philosophy

In recent years, thanks to Node.js, JavaScript has become a universal language that is using for both front and backend applications. This has given rise to awesome projects like Angular, React and NestJS, which improve developer productivity and enable the creation of fast, testable and extensible frontend applications. However, NestJS exists for Node (server-side JavaScript) and successfully solves an Architecture problems for common web applications, but it doesn't provide an opportunity to make applications based on polling like Telegram Bots.

Janko provides an out-of-the-box Telegram Bot application architecture which allows developers and teams to create highly testable, scalable, loosely coupled, and easily maintainable applications. The architecture is heavily inspired by NestJS and Express.

Installation

To get started, you need to initialize your application with npm, yarn or any other package manager and install the main Janko package using the following command:

npm i janko

Documentation

To check out the guide, visit www.jankojs.com

License

Janko is MIT licensed.