clintonbrito/ibm-bootcamp-project

Financial Transaction Manager web application developed from scratch as the final project of an IBM Bootcamp using Java with Spring Boot for back-end and Angular TypeScript framework for front-end.

IBM Bootcamp Project

This web application is a Financial Transaction Manager developed from scratch. It allows users to record transactions, delete them, update transaction details, and retrieve a comprehensive list of all transactions. Consideration for implementing date filtering and categorized totals are potential features for future updates.

🧪 Technologies

This project was developed using:

🚀 Getting started locally

Clone this repository to your local machine and access the cloned directory:

git clone git@github.com:clintonbrito/ibm-bootcamp-project.git
cd ibm-bootcamp-project

Run this command to create all the project's Docker containers and install the dependencies:

npm run compose:up

If you need to stop and remove the project's Docker containers, you can use the following command:

npm run compose:down

Check the front-end docker logs using the command docker logs -f app_frontend which address is running the application and open your browser and access the application through the address below to view the interface locally, for example:

http://localhost:4200/

📖 API Documentation

Explore the API documentation to understand the available endpoints, request parameters, and responses. The documentation is built using Swagger, which provides an interactive and user-friendly interface.

Accessing API Documentation

1. Run the Application: Make sure the application is running locally. Follow the Getting Started section for instructions on starting the application.

2. Open Swagger UI: Once the application is running, you can access the Swagger UI by navigating to the following URL in your web browser:

http://localhost:8080/api/v1/ui

3. Explore Endpoints: In the Swagger UI, you'll find a list of available endpoints along with details about request parameters, expected responses, and sample requests. Use this interface to understand how to interact with the API.

Feel free to explore and test the API directly from the Swagger UI. If you encounter any issues or have questions, refer to the Issues section for support.

🎨 Development Patterns

Commit Patterns

This project adopts Gitmoji and the commit convention known as Conventional Commits. This means that we follow a standardized format for our commit messages, making it easier to generate changelogs and adopt semantic versioning.

Example commit messages format:

feat: add login functionality
fix: resolve issue with user registration
wip: connecting back-end to front-end

Branch Patterns

The branches in this project follow a specific pattern to facilitate organization and understanding of ongoing development. Some of the common prefixes used include feature/, bugfix/, docs/:

Example branch names:

feature/docker-setup
bugfix/eslint-errors
docs/update-readme

📝 License

This project is licensed under the MIT License. See the LICENSE file for details.