Telegram Quizlet bot

Practice your memory in a game format
View Demo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Welcome to our GitHub project, a Telegram bot that enables you to create Quizlet flashcards and use them for learning. Quizlet is an online service for creating and exchanging question-and-answer flashcards for learning purposes.

With this bot, you can easily and quickly create Quizlet flashcards using the convenient interface of Telegram messenger. You can add cards, edit them and use them for learning information.

One of the main advantages of this bot is the ability to use the flashcards you create for learning. You can take tests to assess your knowledge of the material using the flashcards you have created and share them with friends and colleagues.

Moreover, this GitHub project is open and accessible to all who are interested. You can contribute your suggestions and improvements to the project to make it even better and more user-friendly.

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Java 11 or higher
• PostgreSql database
• Telegram Bot API token
• Ngrok

Installation

• Clone the repository:

git clone https://github.com/yourusername/yourproject.git

• Open the project in your preferred IDE.
• Create a PostgreSql database and configure the connection in the application.properties file.
• Create a Telegram Bot and get the API token.
• Set the API token in the application.properties file.
• Run the application using Maven:

mvn spring-boot:run

(back to top)

Usage

1. Start the bot in Telegram by searching for it and clicking the "Start" button.
2. Interact with the bot by sending it messages and receiving responses.
3. View the bot's logs in the console to see what actions are being performed and if there are any errors.

(back to top)

Roadmap

• Add practice mode
• Add statistics tracker
• Add public card pack spaces
• Add full logging
• Multi-language Support
  • English
  • Russian

(back to top)

Contributing

Contributions are always welcome! If you'd like to contribute to this project, please fork the repository and create a pull request.

(back to top)

License

This project is licensed under the MIT License - see the LICENSE file for details.

(back to top)

Contact

telegram - @psajd - polpilik@gmail.com

Project Link: https://github.com/psajd/quizletBot

(back to top)