1. What's DollarBot?
2. Why use DollarBot?
3. Demo
4. What's new in this version?
5. Installation and Setup
6. How to use?
7. Contributors
8. Future Work
9. Acknowledgements

Are you a developer? Click here: For Developers and Future Contributors

DollarBot is a handy little bot built on top of Telegram, to help you with daily expense tracking and analytics on your past spends.

It's easy to setup, run and use on a daily basis!

Click here for a video overview!!

With simple in-chat commands, this bot helps you:

• Set your own customized budget
• Add/Record new spendings
• Display your spending trends through engaging graphs
• Predict your next month's budget based on your current expenditure
• Display your spending history
• Clear/Erase all your records
• Edit/Change any spending details if you wish to
• View Analytics and export as a pdf

Demo Video -> [https://www.youtube.com/watch?v=XlndmRhr9Lc]

We've considerably extended this project to make using DollarBot easy and engaging.\

1. Expressive Graphs
2. Budget prediction
3. Clearer and more informative PDF Reports
4. Ability to add recurring expenses
5. Budget Creation Updated
6. Clearer wording in the documentation

Check this documentation out for an in-depth depiction of our changes. :)

Since DollarBot is built on top of Telegram, you'll first need:

1. Download the Telegram Desktop Application here. https://desktop.telegram.org/
2. Create a Telegram account or Sign in.

Open up your terminal and let's get started:

1. Clone this repository to your local system.

   git clone https://github.com/aditikilledar/dollar_bot_SE23/

2. Start a terminal session in the directory where the project has been cloned. Run the following commands and follow the instructions on-screen to complete the installation.

  chmod a+x setup.sh
  bash setup.sh

There, all done!

The installation is easy for MacOS or on UNIX terminals.

With Windows, you'll need to use a platform to execute UNIX-like commands in order to execute the setup.sh bash script. Once in the platform, use the steps in the MacOS/Unix Section above to setup DollarBot.

We've used Cygwin, but there are more options like WSL that you can explore.

Additionally, find more hints on Cygwin installation here.

Once you've executed setup.sh, and all dependencies have been installed, you can start running DollarBot by following these instructions.

1. Open the Telegram Desktop Application and sign in. Once inside Telegram, search for "BotFather". Click on "Start", and enter the following command:

  /newbot

2. Follow the instructions on screen and choose a name for your bot (e.g., dollarbot). After this, select a UNIQUE username for your bot that ends with "bot", for example: dollarbot_<your_nickname>.

3. BotFather will now confirm the creation of your bot and provide a TOKEN to access the HTTP API - copy and save this token for future use. Make sure you save this token– don't lose it!

4. In the repo directory (where you cloned it), run these commands.

(a) grant execution access to a bash script

chmod a+x run.sh

(b) execute the run.sh bash script to start DollarBot

   bash run.sh

   ./run.sh

Note: It will ask you to paste the API token you received from Telegram while creating your bot (Step 3), so keep that handy. A successful run will generate a message on your terminal that says "TeleBot: Started polling."

5. In the Telegram app, search for your newly created bot by entering your UNIQUE username and open the bot you created.

6. Now, on Telegram, enter the "/start" or "menu" command, and you are all set to track your expenses!

To run the script automatically at startup / reboot, simply add the .run_forever.sh script to your .bashrc file, which executes whenever you reboot your system. Click here for help adding to .bashrc files.

Here's a quick overview of how each of the commands work. Simply enter /<command_name> into the Telegram chat and watch as the magic happens!

1. It will give you the list of categories to choose from.
2. You will be prompted to enter the amount corresponding to your spending
   3.The message will be prompted to notify the addition of your expense with the amount,date, time and category

You will get an option to choose the type of data you want to see.

1. It will give you the list of your expenses you wish to edit
2. It will let you change the specific field based on your requirements like amount/date/category

1. The Add/update category is to set the new budget or update the existing budget
2. The view category gives the detail if budget is exceeding or in limit with the difference amount
3. The delete category allows to delete the budget and start afresh!

Aditi Killedar

Shashank Madan

Srinath Srinivasan

Aditya Iyer

• Sharing expenses
• Windows specific setup scripts
• Adding notes section while recording expenses
• Incorporating Machine Learning insights into the Analytics Feature
• Making DollarBot respond to casual conversation like 'Hi' and 'Bye'

• We would like to express our gratitude 🙏🏻 and a big thank you 😇 to Prof. Dr. Timothy Menzie for giving us the opportunity to get into the shoes of software building and learning new skills and development process throught the project building.
• A big thank you 😊 to the Teaching Assistants for their support.
• Thank you to the previous team 😊 for a thorough ReadMe and deatiled documentation.MyDollarBot
• Thank you to the ⭐️Telegram bot