Lumios is a Telegram bot designed to streamline study management. It offers features such as queue management, ratings, statistics, tasks, timetable, and notifications. Lumios is built with pure Java, TelegramBots and Spring Framework.
- Queues (dynamic list of students for some activities)
- Create queue with custom names
- Create mixed queue with random order
- Join and leave queue any time
- Notify the head of queue about his turn
- Delete whole queue if required
- Reverence (pretty simple statistics system)
- Give reputation to other chat mates
- Take reputation from other chat mates
- Check the chat reputation statistics
- Check your own reputation statistics
- Based on telegram built-in reactions
- Tasks (dynamic list of tasks due on some day)
- Add task to the task list
- Edit task in the task list
- Show the formatted task list
- Timetable (flexible timetable for the chat)
- Create informative timetable for the week
- Add time limits of each lesson a day
- Add URL to the lesson's conferences
- Auto-notification about the upcoming lesson
- Web-Interface to set up the timetable
The project is entirely made using the Java Telegram API Wrapper Library from rubenlagus TelegramBots, using the Chain of Responsibility pattern which delegates specific updates to different Handlers based on their features and unique content. The general structure also uses the Spring Framework (Spring Data, Spring REST, Spring Security) and Spring Boot launcher particularly as out-of-the-box solutions for many possible problems and vulnerabilities in the code. Additionally, the project can be built using Spring Thin-Jar Plugin, so all the dependencies will be downloaded in Runtime, that can also provide us with the minimized jar which contains only required classes
In order to successfully set up the application and launch it in order to somehow enhance the bot, you should specify
credentials for your Telegram bot retrieved via BotFather in Telegram in file named application.properties located
in resources folder, and not only. To clone and start the project you have to:
- Clone the repository:
git clone https://github.com/ikeepcalm/lumios.git - Navigate to the project directory:
cd lumios - Install dependencies:
gradle build - Configure start-up properties:
#credentials
telegram.bot.username= #BOT USERNAME
#rest
rest.api.key = #API KEY FOR THE REST API
rest.api.header = #NAME OF THE API KEY HEADER
#database
spring.datasource.url = #URL OF DB CONNECTION
spring.datasource.username = #USERNAME OF THE DB USER
spring.datasource.password = #PASSWORD OF THE DB USER
#other APIs
tenor.api.key = #TENOR API KEY, IF I'D LIKE TO USE IT- Build the fat-jar using:
gradle clean bootJar
Contributions to Lumios are welcome! To contribute, follow these guidelines:
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and ensure they adhere to the project's coding standards.
- Test your changes thoroughly. Maybe, several times.
- Submit a pull request detailing the changes you've made and the problem they solve.
Optional: Create an Issue on the same project page, where you describe new feature or bug you've encountered as detailed as possible. You may also be asked to provide some more evidence later
Lumios is licensed under the CC BY-NC 4.0 Deed.
For questions, feedback, or inquiries about Lumios, please contact [email protected] or reach directly here.
An official online contribution can be found here.
Feel free to join and try
it out yourself, it's up!