{"id":21076372,"url":"https://github.com/rapter1990/qr-generator-example","last_synced_at":"2025-05-16T06:32:20.463Z","repository":{"id":235660257,"uuid":"621366288","full_name":"Rapter1990/qr-generator-example","owner":"Rapter1990","description":"QR Generator Example with Spring Boot","archived":false,"fork":false,"pushed_at":"2023-04-04T22:19:51.000Z","size":547,"stargazers_count":12,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-24T06:34:03.692Z","etag":null,"topics":["docker","docker-compose","integration-test","java","junit","qrcode","qrcode-generator","restful-api","spring-boot","validation","zxing","zxing-qrcode"],"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/Rapter1990.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,"dei":null}},"created_at":"2023-03-30T14:15:55.000Z","updated_at":"2024-04-24T06:34:07.290Z","dependencies_parsed_at":"2024-04-24T06:34:06.935Z","dependency_job_id":"c5e01050-683d-40d7-a6bf-94ec6a565092","html_url":"https://github.com/Rapter1990/qr-generator-example","commit_stats":null,"previous_names":["rapter1990/qr-generator-example"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fqr-generator-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fqr-generator-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fqr-generator-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fqr-generator-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rapter1990","download_url":"https://codeload.github.com/Rapter1990/qr-generator-example/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225413249,"owners_count":17470546,"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","integration-test","java","junit","qrcode","qrcode-generator","restful-api","spring-boot","validation","zxing","zxing-qrcode"],"created_at":"2024-11-19T19:28:04.247Z","updated_at":"2024-11-19T19:28:04.959Z","avatar_url":"https://github.com/Rapter1990.png","language":"Java","readme":"# Spring Boot QR Generator Example\n\n\u003cimg src=\"screenshots/main_image.PNG\" alt=\"Main Information\" width=\"800\" height=\"500\"\u003e\n\n### 📖 Information\n\n\u003cul style=\"list-style-type:disc\"\u003e\n  \u003cli\u003eThe application receives the requested information to generate \u003cb\u003eQR code\u003c/b\u003e containing text message, color, background color and size with file upload option or not through through `/api/v1/qr-generator`\u003c/li\u003e \n  \u003cli\u003eThe \u003cb\u003eQR code\u003c/b\u003e is generated through validations defined below \n       \u003cul\u003e\n            \u003cli\u003e\u003cb\u003ecolor validation\u003c/b\u003e to check whether color is defined as hex color code\u003c/li\u003e\n            \u003cli\u003e\u003cb\u003etext length validation\u003c/b\u003e to check whether text is ranged between two defined length size (1-50)\u003c/li\u003e\n            \u003cli\u003e\u003cb\u003eSize validation\u003c/b\u003e to check whether if the size should be defined as \u003cb\u003esmall\u003c/b\u003e, \u003cb\u003emedium\u003c/b\u003e and lastly \u003cb\u003elarge\u003c/b\u003e\u003c/li\u003e\n       \u003c/ul\u003e\n  \u003c/li\u003e\n\u003c/ul\u003e\n\n### Explore Rest APIs\n\n\u003ctable style=\"width:100%\"\u003e\n  \u003ctr\u003e\n      \u003cth\u003eMethod\u003c/th\u003e\n      \u003cth\u003eUrl\u003c/th\u003e\n      \u003cth\u003eDescription\u003c/th\u003e\n      \u003cth\u003eValid Request Params\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd\u003ePOST\u003c/td\u003e\n      \u003ctd\u003e/api/v1/qr-generator\u003c/td\u003e\n      \u003ctd\u003eQr Code Generator with Image\u003c/td\u003e\n      \u003ctd\u003e\u003ca href=\"README.md#qrcodegeneratorwithimage\"\u003eInfo\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd\u003ePOST\u003c/td\u003e\n      \u003ctd\u003e/api/v1/qr-generator\u003c/td\u003e\n      \u003ctd\u003eQr Code Generator without Image\u003c/td\u003e\n      \u003ctd\u003e\u003ca href=\"README.md#qrcodegeneratorwithoutimage\"\u003eInfo\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n### Valid Request Body\n\n##### \u003ca id=\"qrcodegeneratorwithimage\"\u003e Qr Code Generator with Image\n```\n    http://localhost:8080/api/v1/qr-generator\n    \n    form-data\n    text : Merhaba\n    size : small\n    color : #0046FF\n    backgroundColor : #64FF00\n    imageFile : File Upload\n```\n\u003cimg src=\"screenshots/qr_code_1.PNG\" alt=\"Main Information\"\u003e\n\n##### \u003ca id=\"qrcodegeneratorwithoutimage\"\u003e Qr Code Generator without Image\n```\n    http://localhost:8080/api/v1/qr-generator\n    \n    form-data\n    text : Merhaba\n    size : small\n    color : #0046FF\n    backgroundColor : #64FF00\n```\n\u003cimg src=\"screenshots/qr_code_2.PNG\" alt=\"Main Information\"\u003e\n\n### Technologies\n\n---\n- Java 17\n- Spring Boot 3.0\n- Open API Documentation\n- Restful API\n- Spring Boot Validation\n- Google Zxing Core\n- Google Zxing Java Standart Edition (SE)\n- Lombok\n- Maven\n- Junit5\n- Mockito\n- Integration Tests\n- Docker\n- Docker Compose\n\n### Prerequisites\n\n---\n- Maven or Docker\n---\n\n### Docker Run\nThe application can be built and run by the `Docker` engine. The `Dockerfile` has multistage build, so you do not need to build and run separately.\n\nPlease follow directions shown below in order to build and run the application with Docker Compose file;\n\n```sh\n$ cd qr-generator-example\n$ docker-compose up -d\n```\n\n---\n### Maven Run\nTo build and run the application with `Maven`, please follow the directions shown below;\n\n```sh\n$ cd qr-generator-example\n$ mvn clean install\n$ mvn spring-boot:run\n```\n\n### Swagger\nYou can reach the swagger-ui through the link shown below\n```\n    http://localhost:8080/swagger-ui/index.html\n```\n\n### Screenshots\n\n\u003cdetails\u003e\n\u003csummary\u003eClick here to show the screenshots of project\u003c/summary\u003e\n    \u003cp\u003e Figure 1 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_1.PNG\"\u003e\n    \u003cp\u003e Figure 2 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_2.PNG\"\u003e\n    \u003cp\u003e Figure 3 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_3.PNG\"\u003e\n    \u003cp\u003e Figure 4 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_4.PNG\"\u003e\n    \u003cp\u003e Figure 5 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_5.PNG\"\u003e\n    \u003cp\u003e Figure 6 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_6.PNG\"\u003e\n    \u003cp\u003e Figure 7 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot_7.PNG\"\u003e\n\u003c/details\u003e","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapter1990%2Fqr-generator-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frapter1990%2Fqr-generator-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapter1990%2Fqr-generator-example/lists"}