{"id":13490079,"url":"https://github.com/acmlira/awesome-bank-api","last_synced_at":"2026-01-16T18:31:44.414Z","repository":{"id":90026812,"uuid":"539743321","full_name":"acmlira/awesome-bank-api","owner":"acmlira","description":"REST API to handle expenses and cash in/out of a bank account.","archived":false,"fork":false,"pushed_at":"2022-09-26T11:57:07.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-21T01:45:56.742Z","etag":null,"topics":["docker","docker-compose","java","rest-api","restful","spring"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acmlira.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-09-22T01:05:19.000Z","updated_at":"2022-10-01T21:08:01.000Z","dependencies_parsed_at":"2023-07-08T16:31:15.769Z","dependency_job_id":null,"html_url":"https://github.com/acmlira/awesome-bank-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acmlira%2Fawesome-bank-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acmlira%2Fawesome-bank-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acmlira%2Fawesome-bank-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acmlira%2Fawesome-bank-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acmlira","download_url":"https://codeload.github.com/acmlira/awesome-bank-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245814704,"owners_count":20676808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","java","rest-api","restful","spring"],"created_at":"2024-07-31T19:00:40.396Z","updated_at":"2026-01-16T18:31:44.383Z","avatar_url":"https://github.com/acmlira.png","language":"Java","funding_links":[],"categories":["Getting Started"],"sub_categories":[],"readme":"# Awesome Bank API\r\n\r\nREST API to handle expenses and cash in/out of a bank account.\r\n\r\n\u003e [awesome-bank-web](https://github.com/acmlira/awesome-bank-web) implements a client and frontend for this project.\r\n\r\n## Goal\r\n\r\nThis project aims to provide the following requirements:\r\n\r\nModel:\r\n- Expense:\r\n  - ID\r\n  - Person name\r\n  - Description\r\n  - Date/time\r\n  - Value\r\n  - Tags\r\n\r\n- Tag (_additional_):\r\n  - ID\r\n  - Code\r\n\r\nFeatures:\r\n- Create an expense\r\n- List all expenses\r\n- List an expense by ID\r\n\r\nNon-functional:\r\n- Persist in a relational database\r\n\r\n## Getting Started\r\n\r\nIt is highly recommended to use:\r\n\r\n```shell\r\ndocker-compose up\r\n```\r\nThe [requests](/requests) folder has some examples of requests, you can execute them via Intellij in order to test.\r\n\r\n## Troubleshooting\r\n\r\nIn order to make the development easy-understandable for everyone, I present to you some tips.\r\n\r\n### Debug in IDE\r\n\r\n1. Bring up Postgres container with:\r\n   ```shell\r\n   docker-compose up postgres\r\n   ```\r\n2. Put some breakpoints and run in debug mode.\r\n\r\n### Integration tests\r\n\r\n1. Bring up Postgres container with:\r\n   ```shell\r\n   docker-compose up postgres\r\n   ```\r\n2. Run integration tests with:\r\n   ```shell\r\n   ./mvnw verify\r\n   ```\r\n\r\n### No effect changes\r\n\r\nClean your docker environment (remove images, networks, containers, etc.).\r\n\r\n## What can be improved?\r\n\r\nI see some improvements:\r\n- Automated integration tests (tradeoff)\r\n- More business rules\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facmlira%2Fawesome-bank-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facmlira%2Fawesome-bank-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facmlira%2Fawesome-bank-api/lists"}