https://github.com/kuro-jojo/expense-tracker-api
Backend API for the Expense Tracker application written in Java Spring Boot.
https://github.com/kuro-jojo/expense-tracker-api
api-rest expense-tracker java spring-boot
Last synced: about 1 month ago
JSON representation
Backend API for the Expense Tracker application written in Java Spring Boot.
- Host: GitHub
- URL: https://github.com/kuro-jojo/expense-tracker-api
- Owner: kuro-jojo
- Created: 2024-12-14T23:07:45.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-29T17:26:48.000Z (about 2 months ago)
- Last Synced: 2025-04-29T18:32:55.385Z (about 2 months ago)
- Topics: api-rest, expense-tracker, java, spring-boot
- Language: Java
- Homepage:
- Size: 251 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Expense Tracker
Backend API for the Expense Tracker application written in Java Spring Boot.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Introduction
The Expense Tracker application allows users to manage their expenses, incomes, and subscriptions. It helps users keep track of their expenses through budgeting, alerting, and visualizations.
## Features
- User authentication and authorization
- Expense and income management
- Subscription tracking
- Email confirmation for user registration
- Budgeting and alerts (TODO)
- Cool graphs and visualizations (TODO)
## Installation
To install and run the project locally, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/yourusername/expense-tracker.git
cd expense-tracker
```
2. Install dependencies:
```sh
./mvnw install
```
3. Build the project:
```sh
./mvnw package
```
## Configuration
1. Create a `.env` file in the root directory and add the necessary environment variables:
```env
SPRING_GMAIL_USERNAME=
SPRING_GMAIL_PASSWORD=
SPRING_MYSQL_HOST=localhost
SPRING_MYSQL_DB_NAME=expense_tracker
SPRING_MYSQL_USERNAME=user
SPRING_MYSQL_PASSWORD=password
SPRING_JWT_SECRET_KEY=
```
2. Update the [application.yaml](src/main/resources/application.yaml) file with your configuration settings:
```yaml
server:
port: 8080
bert-cat-api:
url:
```
The bert API is used to classify the user's expenses into categories. You can find more information about the API here (TODO).
## Usage
To run the application, use the following command:
```sh
./mvnw spring-boot:run
```
The application will be available at http://localhost:8080.
## Testing
To run the tests, use the following command:
```sh
./mvnw test
```
## Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes.
## License
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.