mendaomn / 6jars-bot

A Telegram bot for the 6 Jars Money Management System.

Home Page:https://t.me/sixjarsbot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

6jars-bot πŸ€–

A Telegram bot for the 6 Jars Money Management System.


Table of Contents πŸ“š


Introduction 🌟

The 6jars-bot leverages the power of the Telegram platform to offer a seamless and efficient way to manage your finances using the 6 jars money management system. Inspired by the need for a simple, non-intrusive way to monitor monthly expenses without the hassle of detailed categorization, this bot integrates directly into the Telegram ecosystem, making expense tracking as easy as sending a message.

Why 6jars-bot? πŸ’‘

Frustrated with traditional expense tracking methods, I sought a solution that would fit into my existing routines. Telegram's speed and convenience for note-taking presented a perfect platform. The 6jars-bot is born out of the necessity to understand where my money goes each month, aligning with the principles of the 6 Jars Money Management System.

Features ✨

  • Expense Tracking: Log expenses with simple commands.
  • View Jar Totals: Instantly see how your money is distributed across the 6 jars.
  • Income Tracking: Easily add your earnings, like salary, into the system.
  • Money Management: Follows the 6 jars system to automatically allocate funds appropriately.
  • Transfer Between Jars: Manage your funds by moving money between jars as needed.

Built With πŸ”¨

  • Node.js & TypeScript
  • Netlify Functions
  • FaunaDB
  • Telegraf

Getting Started πŸš€

To run the 6jars-bot locally:

  1. Clone the repository.
  2. Run npm install to install dependencies.
  3. Execute npm run dev to start the development server.
  4. Ensure you have the necessary environment variables: FAUNA_SECRET, TELEGRAM_TOKEN, and AUTHENTICATION_TOKEN.

Note: The AUTHENTICATION_TOKEN serves as a simple security measure, ensuring that only authorized users can interact with the bot.

Contributing 🀝

Open to suggestions, reports, and contributions.

About

A Telegram bot for the 6 Jars Money Management System.

https://t.me/sixjarsbot

License:MIT License


Languages

Language:TypeScript 99.5%Language:JavaScript 0.3%Language:Shell 0.2%