{"id":15069112,"url":"https://github.com/tascigorkem/restaurant-service","last_synced_at":"2025-04-10T17:36:39.759Z","repository":{"id":98235785,"uuid":"271746768","full_name":"tascigorkem/restaurant-service","owner":"tascigorkem","description":"Rest Api - Hexagonal Architecture with Spring WebFlux and PostgreSQL R2DBC. - Deployed to Heroku with Travis CI.","archived":false,"fork":false,"pushed_at":"2023-12-05T21:55:50.000Z","size":21676,"stargazers_count":10,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T15:11:21.955Z","etag":null,"topics":["docker","heroku","hexagonal-architecture","java-11","logentries","postgresql","r2dbc","rest-api","restaurant-service","spring-boot","spring-webflux","tdd","travis-ci"],"latest_commit_sha":null,"homepage":"https://cb-restaurant-service.herokuapp.com/swagger-ui.html","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/tascigorkem.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":"2020-06-12T08:20:59.000Z","updated_at":"2024-10-19T14:21:19.000Z","dependencies_parsed_at":"2024-09-29T14:00:45.332Z","dependency_job_id":"bba67c46-321f-433e-9235-709f75f33b14","html_url":"https://github.com/tascigorkem/restaurant-service","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tascigorkem%2Frestaurant-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tascigorkem%2Frestaurant-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tascigorkem%2Frestaurant-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tascigorkem%2Frestaurant-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tascigorkem","download_url":"https://codeload.github.com/tascigorkem/restaurant-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248262042,"owners_count":21074233,"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","heroku","hexagonal-architecture","java-11","logentries","postgresql","r2dbc","rest-api","restaurant-service","spring-boot","spring-webflux","tdd","travis-ci"],"created_at":"2024-09-25T01:40:31.651Z","updated_at":"2025-04-10T17:36:39.736Z","avatar_url":"https://github.com/tascigorkem.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Restaurant Service for Food Order System\n\n\u003cp align=\"center\"\u003e\n    \u003ca alt=\"Java\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Java-v1.11-orange.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Spring Boot\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Spring%20Boot-v2.3.1-brightgreen.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Dependencies\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Contributions\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/contributions-welcome-orange.svg\" /\u003e\n    \u003c/a\u003e\n    \u003ca alt=\"Licence\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/tascigorkem/flight-reservation-api\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\nRESTful Restaurant Service - Hexagonal Architecture with Spring WebFlux and Postgresql R2DBC\n\n### Hexagonal architecture\n\nUsed hexagonal architecture with TDD for this project.\n\nExample Flow:\n\n\u003cimg src=\"./docs/hexa-diagram.jpg\" alt=\"\" width=\"600\"\u003e\n\n\u003cimg src=\"./docs/project-structure.png\" alt=\"\" width=\"300\"\u003e\n\n## CI \u0026 Deployment\n\n`Github` repo connected `Travis CI` and triggered after every push to the `master` branch, then build application and running tests and started deploy to `Heroku`.\n\nConnected `Logentries` distributed tracing tool to Heroku Application for monitoring.\n\n#### Travis CI\n\nLooking `.travis.yml` in beginning to build and takes CI configurations.\n\n`...`\n\n`mvn clean install -DskipITs`\n\n``...``\n\nScreenshot: `./docs/travis-ci.pdf`\n\n\u003cimg src=\"./docs/travis-ci.png\" alt=\"\" width=\"800\"\u003e\n\n#### Heroku\n\nLooking `Procfile` (below) in beginning to deploy and takes environment variables.\n\n`web: java -Dserver.port=$PORT -Dspring.profiles.active=heroku $JAVA_OPTS -jar target/restaurant-service-0.0.1-SNAPSHOT.jar`\n\nScreenshot: `./docs/heroku-dashboard.pdf`\n\n\u003cimg src=\"./docs/heroku.png\" alt=\"\" width=\"800\"\u003e\n\n#### Logentries\n\nScreenshot: `./docs/logentries-1.pdf`\n\nScreenshot: `./docs/logentries-2.pdf`\n\nScreenshot: `./docs/logentries-3.pdf`\n\n\u003cimg src=\"./docs/logentries-3.png\" alt=\"\" width=\"800\"\u003e\n\n## Docker\n\nApplication dockerized via `./Dockerfile` and pushed `DockerHub`. \n\nhttps://hub.docker.com/r/tascigorkem/restaurant-service\n\n`docker pull tascigorkem/restaurant-service`\n\n`docker run -p 8080:8080 restaurant-service`\n\n## Tests\n\nUsed JUnit5 \u0026 Mockito.\n\nRun `mvn integration-test` for Integration Tests (**/*IT.class)\n\nRun `mvn test` for Unit Tests (**/*Test.class)\n\n#### Test Pattern\n\nUsed patterns:\n\n* TDD (Test Driven Development)\n\n* 3A (Arrange, Act, Assert) \n\n* Given, When, Then and BDD (Behavior-Driven Development)\n\nfor unit tests and integration tests.\n\n\u003cimg src=\"./docs/unit-test.png\" alt=\"\" width=\"800\"\u003e\n\n#### Test Coverage\n\n98% classes, 96% lines covered in project.\n\n\u003cimg src=\"./docs/test-coverege.png\" alt=\"\" width=\"500\"\u003e\n\n## Database\n\n#### Postgres - R2DBC\n\nUsed Postgres for DB and R2DBC for Postgres for CRUD operations.\n\nDatabase Schema Generation - Sql: `./src/test/resources/schema.sql`\n\nDatabase Example Inserts - Sql: `./src/test/resources/inserts.sql`\n\nDatabase Credentials: `./src/main/resources/application-heroku.properties`\n\n\u003cimg src=\"./docs/diagram.png\" alt=\"javadoc\" width=\"400\"\u003e\n\n## Docs\n\nDocs located `./docs` folder in project main folder.\n\n#### Javadoc\n\nUsed javadoc standarts for method comments.\n\nRun `mvn javadoc:javadoc` for create javadocs.\n\n\u003cimg src=\"./docs/javadoc.png\" alt=\"javadoc\" width=\"800\"\u003e\n\n#### Swagger \u0026 Api-Docs\n\nUsed Swagger and Api-Docs for RestAPI endpoints.\n\nhttps://cb-restaurant-service.herokuapp.com/swagger-ui.html\n\nhttps://cb-restaurant-service.herokuapp.com/api-docs\n\n\u003cimg src=\"./docs/add-food-request.png\" alt=\"\" width=\"800\"\u003e\n\n\u003cimg src=\"./docs/get-all-foods-request.png\" alt=\"\" width=\"800\"\u003e\n\n## Notes\n\n**Scenario:** \"Scotch Eggs\" food added under the menu with POST request and its normal price that identified by company is $20.57, \nbut restaurant extended its price to $26.56 while adds to menu.\n\n\nhttps://cb-restaurant-service.herokuapp.com/foods/1a713ef5-0078-452d-958e-770fbb797797\n\nResponse:\n\n`GET: /foods/{id}`\n \n```json\n{\n    \"statusCode\": 200,\n    \"status\": \"OK\",\n    \"payload\": {\n        \"id\": \"1a713ef5-0078-452d-958e-770fbb797797\",\n        \"name\": \"Scotch Eggs\",\n        \"vegetable\": false,\n        \"price\": 20.57,\n        \"imageUrl\": \"www.tonita-langosh.biz\"\n    }\n}\n```\n\nhttps://cb-restaurant-service.herokuapp.com/menus/8b03175c-af6c-4cab-a958-70d53369fe5c/\n \n`GET: /menus/{id}`\n\n Response:\n\n ```json\n {\n     \"statusCode\": 200,\n     \"status\": \"OK\",\n     \"payload\": {\n         \"id\": \"8b03175c-af6c-4cab-a958-70d53369fe5c\",\n         \"name\": \"magni\",\n         \"menuType\": \"et\",\n         \"restaurantId\": \"9d7cfe42-e7dd-44b5-b01b-2fbaa6dd619e\"\n     }\n }\n ```\n \n\nhttps://cb-restaurant-service.herokuapp.com/menus/8b03175c-af6c-4cab-a958-70d53369fe5c/foods/1a713ef5-0078-452d-958e-770fbb797797\n\n`POST: /menus/{menuId}/foods/{foodId}`\n\nRequest:\n\n```json\n{\n  \"extended\": true,\n  \"extendedPrice\": 26.56\n}\n ```\n\n`GET: /menus/{menuId}/foods/{foodId}`\n\nResponse:\n\n```json\n{\n     \"statusCode\": 200,\n     \"status\": \"OK\",\n     \"payload\": {\n         \"id\": \"c91160e7-0820-425f-8def-17442672c48a\",\n         \"menuId\": \"8b03175c-af6c-4cab-a958-70d53369fe5c\",\n         \"foodId\": \"1a713ef5-0078-452d-958e-770fbb797797\",\n         \"foodName\": \"Scotch Eggs\",\n         \"originalPrice\": 20.57,\n         \"extended\": true,\n         \"extendedPrice\": 26.56\n     }\n }\n ```\n\n## Contributing\n1. Fork it (\u003chttps://github.com/tascigorkem/restaurant-service/fork\u003e)\n2. Create your feature branch (`git checkout -b feature/...`)\n3. Commit your changes (`git commit -am 'Add some ...'`)\n4. Push to the branch (`git push origin feature/...`)\n5. Create a new Pull Request\n\n## References\n\nhttps://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html\n\nhttps://docs.spring.io/spring-data/r2dbc/docs/1.1.0.RELEASE/reference/html/#reference\n\n\n## License\nRestaurant Service is developed under the [MIT License](LICENSE).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftascigorkem%2Frestaurant-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftascigorkem%2Frestaurant-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftascigorkem%2Frestaurant-service/lists"}