ShortlyMsg / qr-code-generator-backend

QR Code Generator Backend Application

QR Code Generator BackEnd

A QR Code Generator BackEnd application implemented in Java 17 using Zxing barcode processing library.

QR Code Generator Backend serves on a Heroku instance in production from the QR Code Generator Backend End-Point.

Table of Contents

1. How to Contribute
2. Credits
3. Requirements
4. Coding Standards
5. Version Control Standards
6. Running the Application Locally
7. Running the Application in Docker
8. Run Actuator
9. Run Swagger UI
10. Extra Notes
11. Copyright

How to Contribute

For the contributor covenant to this project, please check the Code of Conduct file.

Credits

Below you can find the names of the contributors to this project;

• Evren Tan

Requirements

For building and running the application belows are required;

• Spring Boot 2.6.7
• JDK 17
• Gradle 7.3 or above
• Zxing 3.5.0 or above

Coding Standards

Below coding standards should be followed within the project;

• Javadoc should be written for each class & method. @author, @since annotations should be added while adding or updating the javadoc
• General code structure should be followed while adding or refactoring classes.

Version Control Standards

Below version control standards should be followed within the project;

• Feature enhancements or defect fixes should not be committed to main branches, they should be coded in feature or fix branches.
• Issues should be created for each feature or fix in the QR Code Generator Workspace GitHub Repository Project.
• Pull request (PR) should be created for each feature/fix branch to main branches.
• While creating a PR "feature:", "fix:" or "doc:" prefix should be used to identify the PR type.
• PRs should be linked with a valid issue in the QR Code Generator Workspace GitHub Repository Project.

Running the application locally

Application can be run with QrCodeGeneratorBackendApplication class.

Alternatively you can use the Spring Boot Gradle plugin like so:

gradle clean build
gradle bootRun

Running the Application in Docker

Application can be run in Docker. Dockerfile in the project root folder is the configuration file for Docker build.

gradle build
docker build -t qr-code-generator:1.0.0 .
docker run -p 8081:8081 --name QrCodeGenerator qr-code-generator:1.0.0

Run Actuator

Spring Boot Actuator can be reached from local url for Actuator.

Only health and caches endpoints are enabled by default. Configuration can be updated within the "actuator" section of the related application.properties file.

Run Swagger UI

Swagger UI can be reached from local url for Swagger UI and production url for Swagger UI.

Extra Notes

• The module can be booted with Spring Cloud Config Server or directly within the application. In order to boot the project within itself, enable the properties in application.properties file and disable bootstrap.properties file.

Copyright

GNU General Public License v3.0 Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. Please check the LICENSE file for more details.