https://github.com/devadathanmb/rit-attendance-bot
A telegram bot to view your attendance details from RIT Soft.
https://github.com/devadathanmb/rit-attendance-bot
telegrafjs telegram-bot
Last synced: about 1 month ago
JSON representation
A telegram bot to view your attendance details from RIT Soft.
- Host: GitHub
- URL: https://github.com/devadathanmb/rit-attendance-bot
- Owner: devadathanmb
- Created: 2022-12-30T18:41:54.000Z (about 3 years ago)
- Default Branch: devel
- Last Pushed: 2024-01-02T18:47:13.000Z (about 2 years ago)
- Last Synced: 2024-01-02T19:49:23.552Z (about 2 years ago)
- Topics: telegrafjs, telegram-bot
- Language: JavaScript
- Homepage:
- Size: 3.53 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Attendance Bot 
A bot to continue the legacy of now dead Attendance Bot
Find the bot here.
## What does this bot do?
As said above, this bot helps you see your attendance details published in [RIT Soft](http://rit.ac.in/ritsoft/ritsoftv2/) just with a few commands. I found that the popular [atttendancebot](https://t.me/atttendancebot) is now not working anymore so I decided to make my own.
## Previews
## Bot usage
See the available commands to see how to use the bot.
### Bot commands
```
/start - To start the bot
/login username:password - To login and create a new session.
/attendance - See attendance details.
/lastupdate - See lastupdate details.
/absent - See absent hours and details.
/present - See present hours and details.
/help - Help me!
```
## Development
To run this on your own development environment, do the following steps.
### Using Docker
1. Make sure [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) is installed on your machine.
2. Clone the repository
```bash
git clone https://github.com/devadathanmb/attendance-bot.git
cd attendance-bot/
```
3. Create a `.env` file in the cloned directory and setup the environment variables (see [env.example](./env.example) for more info.)
4. Build and run your image using
```bash
docker compose up
```
### Without Docker
It's almost the same steps as above.
1. Make sure [node](https://nodejs.org/en/), [npm](https://www.npmjs.com/), [git](https://git-scm.com/) is installed on your machine.
2. Clone the repository.
```bash
git clone https://github.com/devadathanmb/attendance-bot
```
3. Change directory into the cloned repository
```bash
cd attendance-bot
```
4. Install the required dependencies
```bash
npm install
```
5. Create a `.env` file and setup the environment variables (see [env.example](./env.example) for more info.)
6. Run the bot using
```bash
nodemon app.js --ignore sessions.json
```
## Acknowledgements
- Thanks to [icons8](https://icons8.com) and [flaticon](https://www.flaticon.com/) for the icons.