white07s/budget

Family Budget for sharing expenses and income

FamilyBudget

An API for Family Budget project in Django

• Implementation Technologies:
  • Backend:
    • Python 3.8
    • FastAPI 0.83
  • Communication:
    • REST API
      • Backend: [Rest Framework]
  • Docs:
    • Markdown Lint

Compile and Run

chmod +x /scripts/build.sh

./scripts/build.sh

docker-compose up -d

• if want to test backend

./scripts/test_backend.sh

• Functionalities

  • User Registration
  • Email validation (PyDantic)
  • Passlib Encryption for password
  • JWT Token Authorization
  • Users can create budgets
  • Users can share to any other users
  • Tests
  • Pagination
  • Filtering
  • Redis Implemented for Caching
  • Search based on Category(Income,Expenses)
  • CORS configuration (Its configured for all domain) [For production: it will be restricted to list or orgin needed for api]
  • NGINX added
  • Frontend half-done

• Get methods

• /users/{id} by id

• /budget

• /budget based on URL pagination and serach by category like /budget?limit=10@search="expenses"

• /getallbudget

• Post Methods

• /login

• /signup

• /budget

• /share with id as list in input

NOTE: for production we need to change docker param and setup env