late-dev / cashflow Goto Github PK

View Code? Open in Web Editor NEW

4.0 2.0 1.0 21.2 MB

Cashflow telegram bot

License: MIT License

Dockerfile 0.53% Python 23.92% Shell 0.04% HTML 0.92% Vue 41.43% TypeScript 18.28% SCSS 5.09% JavaScript 9.79%

python telegram-bot telegram-miniapp-contest-2023 telegram-web-app vue telegram-mini-app

cashflow's Introduction

Cashflow

Cashflow is an application for financial management and collaborative planning with your loved ones.

With Cashflow, you can:

Track your expenses No more need for complicated spreadsheets. Cashflow allows you to easily record and monitor all your expenses in a user-friendly interface.
Build savings Plan your savings and goals. Watch as your budget grows to achieve your dreams.
Create shared wallets Invite your friends and family to shared wallets for joint financial management. Shared purchases or trips have become easier!
Analyze finances Cashflow provides convenient reports and analytics to help you better understand where your money is going and how to save.

Features

Requirements

docker
docker-compose

How to run

Create .env file

Example

POSTGRES_USER=admin
POSTGRES_PASSWORD=admin

[email protected]
PGADMIN_DEFAULT_PASSWORD=root

TOKEN=<your telegram token>
SECRET_KEY=<your secret_key>

API_URL=http://<your URL>:8000

WEBAPP_TG_URL=https://t.me/<bot_name>/<webapp_name>
WEBAPP_URL="https://<frontend URL>/#/"

BOT_SECRET=<secret bot key>

Run docker compose --env-file .env up

Database schema

Services

swagger

http://<your URL>:8000/docs

pgadmin4

http://<your URL>:5050/

frontend

https://<your URL>:80/ should have SSL certificate. This ip should be added to your bot via https://t.me/BotFather

cashflow's People

Contributors

Stargazers

Watchers

Forkers

mistermusk

cashflow's Issues

add new category

POST /categoryList/<wallet id>

body:

{
name: str, 
type: str <income | outcome>, 
icon?: str, 
color?: str 
}

wallet info API endpoint request

GET /wallet/<wallet id>

response:

{
 outcomes: [
 {
  id: str,
  category: str,
  value: num,
  date: str,
  description: str,
  user: <user>,
  source: str
 }
  ],
 incomes: [
  id: str,
  category: str,
  value: num,
  date: str,
  description: str,
  user: <user>,
  source: str
  ],
}

user wallets API endpoint request

GET /userWallets

response:
[ { id: str; name: str; currency: str; } ]

get categories

GET /categoryList/<wallet id>

response:
[ { id: str, name: str, type: str <income | outcome>, icon?: str, color?: str } ]

fix .env file for frontend environment

merge backend and front .env files

edit category

edit transaction

PATCH /transaction/<transaction id>

body:

{
  category: str (id),
  value: num,
  date: str,
  description: str,
  source: str, 
  type: str <income | outcome>
}

delete wallet

DELETE /wallet/<wallet id>

params:
id: number (wallet id)

sort transactions by date

add transaction API endpoint request

POST /transaction

body:

{
  category: str (id),
  value: num,
  date: str,
  description: str,
  source: str, 
  type: str <income | outcome>
wallet_id: number
}

response:

user auth agreement

every request send header Authorization with bearer token.
First token gets after validating data
https://core.telegram.org/bots/webapps#validating-data-received-via-the-mini-app

POST /auth

params:
initData

response:
{token: <jwt>}

save and return user info in transaction

We need to collect, store and return info about user that created transaction

delete transaction

DELETE /transaction/<transaction id>

params:
id: string (transaction id)

late-dev / cashflow Goto Github PK

cashflow's Introduction

Cashflow

Features

Requirements

How to run

Database schema

Services

swagger

pgadmin4

frontend

cashflow's People

Contributors

Stargazers

Watchers

Forkers

cashflow's Issues

Recommend Projects

Recommend Topics

Recommend Org