nelsonVE / home-expenses

Home expenses project

This is a simple hobby project made to simplify the task of sharing monthly expenses with other people.

Developed using Django, pyTelegramBot, Bootstrap and HTMX

More details

This application allows you to:

• Create expenses, select who paid and automatically do shares to each active user in the project.
• Discount the (active_users_count - 1) / active_users_count part of an amount paid for a person.
• List all expenses in a specific month and filter by month and year.
• List your expenses in a specific month/year and filter.
• Make automatically a monthly close with the monthly total amount, your discounted amount and how much you need to pay
• Send an email each 1st of month notifying the payment amount
• Use the telegram bot to request details of the monthly expenses
• [] Allow per user discount and price add
• [] Add permissions (low priority)

How to setup

To setup the project and run in your machine, please do the follow steps:

1. Clone the github project

$ git clone https://github.com/nelsonVE/home-expenses.git
$ cd home-expenses

2. Create a virtualenv

3. Install all the dependencies using:

pip install -r requirements.txt

4. Declare your environment variables using the .env.example file and rename it to .env

5. Run the migrations

python manage.py migrate

6. Run the project

python manage.py runserver