BudMan

Web App url https://budman.azurewebsites.net/

BudMan is a web app that helps you track and adjust your spending so that you are in control of money.

Screenshots

Built With

Run Locally

Just follow this steps to run locally

Clone the Project

  git clone https://github.com/supsa-ak/BudMan.git

Go to the Project Directory

  cd BudMan

Create Virtual Environment

virtualenv env

Activate Virtual Environment

.\env\Scripts\activate

Install Dependencies

  pip install -r requirements.txt

Run Development Server

python manage.py runserver

API Reference

User must be logged in for using apis

Get All Spendings

  GET /api/

SAMPLE JSON RESPONSE

{
    "data": [
        {
            "id": 26,
            "user": 1,
            "created": "2021-12-25T22:37:48.883377+05:30",
            "name": "asdf",
            "amount": 33,
            "category": "Fees",
            "note": "asdf"
        },
        {
            "id": 27,
            "user": 1,
            "created": "2021-12-25T22:38:02.467361+05:30",
            "name": "asdf",
            "amount": 33,
            "category": "Rent",
            "note": "adf"
        },
        {
            "id": 28,
            "user": 1,
            "created": "2021-12-25T22:41:32.641703+05:30",
            "name": "asdf",
            "amount": 23,
            "category": "Travel",
            "note": ""
        }
    ]
}

Create Spending

  POST  /api/create-transaction

Parameter	Type	Description
name	string	Required. Name of Spending
amount	integer	Required. Spending Amount
category	string	Required. Category of Spending
note	string	Required. About Spending

SAMPLE JSON REQUEST

{
    "name": "water bottle",
    "amount": 100,
    "category": "Shopping",
    "note": "Purchased from local store"
}

SAMPLE JSON RESPONSE

{
    "id": 36,
    "user": 1,
    "created": "2022-01-09T20:33:32.622050+05:30",
    "name": "water bottle",
    "amount": 100,
    "category": "Shopping",
    "note": "Purchased from local store"
}

Update Spending

  POST  /api/update-transaction

Parameter	Type	Description
id	integer	Required. Id of Spending
name	string	Required. Name of Spending
amount	integer	Required. Spending Amount
category	string	Required. Category of Spending
note	string	Required. About Spending

SAMPLE JSON REQUEST

{
    "id": 36,
    "name": "water bottle",
    "amount": 100,
    "category": "Shopping",
    "note": "Purchased from local store"
}

SAMPLE JSON RESPONSE

{
    "id": 36,
    "user": 1,
    "created": "2022-01-09T20:33:32.622050+05:30",
    "name": "water bottle",
    "amount": 100,
    "category": "Shopping",
    "note": "Purchased from local store"
}

Delete Transaction

  POST  /api/delete-transaction

Parameter	Type	Description
id	integer	Required. Id of Spending

SAMPLE JSON REQUEST

{
    "id": 36
}

SAMPLE JSON RESPONSE

{
    "message": "Deleted Successfully"
}

License

MIT License

Copyright (c) 2021 Sarthak Kalpande

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.