Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ardac67/expense_tracker
Some sort of api i tried to make :)
https://github.com/ardac67/expense_tracker
docker mongodb vertx
Last synced: about 2 months ago
JSON representation
Some sort of api i tried to make :)
- Host: GitHub
- URL: https://github.com/ardac67/expense_tracker
- Owner: ardac67
- Created: 2023-07-31T07:58:08.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-08-04T09:25:49.000Z (over 1 year ago)
- Last Synced: 2024-11-01T02:23:29.131Z (3 months ago)
- Topics: docker, mongodb, vertx
- Language: Java
- Homepage:
- Size: 106 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Expense Tracker
## Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
- [API Endpoints](#api-endpoints)
## Introduction
Expense Tracker is a simple backend project designed for learning purposes. It allows users to track their expenses within a specified timeline. Please note that this project is not intended for professional use, and certain APIs have been omitted for security reasons.
## Installation
To get started with Expense Tracker, follow these steps:
1. Clone this repository to your local machine:
2. Navigate to the project directory:
3. Build the project using gradle:
4. Run the application:
**Note**: This project utilizes a MongoDB container from Docker. Ensure that you handle it properly or install Docker if you want to use it.
## API Endpoints
Expense Tracker provides API endpoints for various functionalities. Below are the available endpoints:
1. **GET /track/getPosts**
- Description: Fetches all expense posts according to a given timeline. Requires basic authentication.
- Request Parameters:
- Key: startDate (Required) - Value: 2023-01-01
- Key: endDate (Required) - Value: 2023-12-12
- Response: Provides a list of expenseTypes with their values and the userId of the expenses.
2. **GET /track/getPosts**
- Description: Fetches all expenses and generates a report for the given timeline. Requires basic authentication.
- Request Parameters:
- Key: startDate (Required) - Value: 2023-01-01
- Key: endDate (Required) - Value: 2023-01-01
- Key: desiredCurrencies (Required) - Populated with the currencies to fetch data for. Value: "TRL"
- Key: currencyDate (Required) - Gets the value of the currencies for that date. Value: 2023-01-01
- Response: Calculates the total expenses for the given timeline and provides a report with total and unit-based values for all requested currencies. Possible response codes are 200 and 400 (bad request, some parameters may be missing or not properly formatted).
```json
{
"UserId": "64c77ce88b343523d050130f",
"BaseCurrency": "USD",
"StartDate": "2023-01-01",
"EndDate": "2023-12-12",
"CurrencyDate": "2022-07-20",
"Currency": {
"GBP/USD": 1.1976,
"EUR/USD": 1.01806
},
"USD": {
"health": 20759.68,
"Transportation": 17158.63,
"Education": 4931.2,
"food": 7850.0,
"Entertainment": 2650.0,
"Utilities": 2030.0,
"Total": 55379.51
},
"OtherCurrencies": {
"GBP": {
"health": 17334.4,
"Transportation": 14327.51,
"Education": 4117.57,
"food": 6554.78,
"Entertainment": 2212.76,
"Utilities": 1695.06,
"Total": 46242.08
},
"EUR": {
"health": 20391.41,
"Transportation": 16854.24,
"Education": 4843.72,
"food": 7710.74,
"Entertainment": 2602.99,
"Utilities": 1993.99,
"Total": 54397.1
}
}
}
```
3. **POST /createUser**
- Description: Creates a user with the provided data. No authentication is required.
- Request Body:
```json
{
"name": "ardaTest1", // Name of the user
"password": "123", // Password of the user
"currency": "USD" // Currency used as the base currency for calculations
}
```
- Response: Returns code 201 if the user is created successfully or code 401 if there is a bad request.
4. **POST /track/createExpense**
- Description: Posts the body of the request as an expense. Requires authentication.
- Request Body: A sample body is provided, and additional fields can be added if desired.
```json
[
{
"expenseType": {
"health": 1200.50,
"Transportation": 1000.25,
"Education": 300.75,
"food": 500.00,
"Entertainment": 200.00,
"Utilities": 150.00
},
"submittedDate": "2023-09-25"
}
]
```
- Response: Returns code 201 if the request is successful (expense is created) or code 400 if the request is bad (invalid schema).