{"id":15174146,"url":"https://github.com/timtwiest/simple-java-api","last_synced_at":"2026-01-26T12:05:42.512Z","repository":{"id":229302780,"uuid":"775017514","full_name":"timtwiest/simple-java-api","owner":"timtwiest","description":"A simple Java API written with Spring Boot and OpenAPI","archived":false,"fork":false,"pushed_at":"2024-04-21T20:38:45.000Z","size":39,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-31T10:14:25.426Z","etag":null,"topics":["cucumber","docker","jacoco","java","junit5","maven","openapi","postgresql","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timtwiest.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-20T16:01:13.000Z","updated_at":"2024-04-21T20:38:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"8654aabb-a40f-4db1-8921-0f997fd55e06","html_url":"https://github.com/timtwiest/simple-java-api","commit_stats":{"total_commits":17,"total_committers":1,"mean_commits":17.0,"dds":0.0,"last_synced_commit":"97d80706f848ed70045121bc81706ee790ff697c"},"previous_names":["timtwiest/simple-java-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timtwiest%2Fsimple-java-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timtwiest%2Fsimple-java-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timtwiest%2Fsimple-java-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timtwiest%2Fsimple-java-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timtwiest","download_url":"https://codeload.github.com/timtwiest/simple-java-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239887106,"owners_count":19713598,"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":["cucumber","docker","jacoco","java","junit5","maven","openapi","postgresql","spring-boot"],"created_at":"2024-09-27T11:40:16.675Z","updated_at":"2026-01-26T12:05:37.477Z","avatar_url":"https://github.com/timtwiest.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# simple-java-api\n\n## Table of Contents\n\n1. [Requirements](#requirements)\n2. [Getting Started](#getting-started)\n3. [Containerization](#containerization)\n4. [OpenAPI](#openapi)\n5. [Roadmap](#roadmap)\n6. [Contributing](#contributing)\n\n## Requirements\n\n- Java 21 Temurin\n- Apache Maven 3.6.3 or higher\n- PostgreSQL 9.6 or higher\n- Docker 20.10.21 or higher\n- Docker Compose 2.13.0 or higher\n\n## Getting Started\n\n### Clone the Repository\n\nClone the repository to your local machine:\n\n```bash\ngit clone git@github.com:timtwiest/simple-java-api.git\n```\n\n### Run the PostgreSQL Database\n\nStart the PostgreSQL database using Docker Compose:\n\n```bash\ndocker-compose up -d postgres-db\n```\n\n### Build the Project\n\nBuild the project using Maven:\n\n```bash\nmvn clean install\n```\n\n## Containerization\n\nThis application is designed to be containerized using Docker. This allows the Spring Boot application to run in a\nreproducible environment.\n\n### Creating a Docker Image\n\nCreate a Docker image of the application:\n\n```bash\ndocker build -t simple-java-api .\n```\n\n### Starting the Application\n\nUse the provided `docker-compose.yaml` to start both the PostgreSQL instance and the application:\n\n```bash\ndocker-compose up -d\n```\n\n## OpenAPI\n\nThe application features an OpenAPI interface for easy interaction with the API. It provides a user-friendly way to view\nand test the endpoints.\n\nYou can access the OpenAPI-interface locally at http://localhost:9080/api/ui.\n\n## Roadmap\n\n_coming soon_\n\n## Contributing\n\n_coming soon_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimtwiest%2Fsimple-java-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimtwiest%2Fsimple-java-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimtwiest%2Fsimple-java-api/lists"}