main-backend-java

liBRBary Application

liBRBary - Buy, Rental, Barter.

Local workspace setup guidelines

Pre-requisite

• Install Java 17 on your system
• Install Maven if not using bundled maven
• Install Docker Application

Steps to setup liBRBary backend application in local

• Run Docker Engine.

• After checking out your feature branch in your local, first step is to build the application using Maven
  mvn clean install

• To check code indentation, use below command
  mvn spotless:check

• To organize your code and fix code indentation, use below command
  mvn spotless:apply

• To run only junit tests, use below command
  mvn clean test

Cucumber Tests

• To run Functional Tests BDDs, use below command
  mvn clean test -Dcucumber.filter.tags="@FunctionalTest" -Dcucumber.glue="com.librbary.main.bdd.api.config.e0,com.librbary.main.bdd.api.stepdefs"

• To run PostDeployment Tests BDDs, use below command
  mvn clean test -Dcucumber.filter.tags="@PostDeploymentTests" -Dcucumber.glue="com.librbary.main.bdd.api.config.e1,com.librbary.main.bdd.api.stepdefs"

• To run a particular feature or scenario for Functional Tests, please add the below configurations in 'Edit Configuration...'
  Glue: com.librbary.main.bdd.api.config.e0 com.librbary.main.bdd.api.stepdefs

• To run a particular feature or scenario for PostDeployment Tests, please add the below configurations in 'Edit Configuration...'
  Glue: com.librbary.main.bdd.api.config.e0 com.librbary.main.bdd.api.stepdefs

CI/CD Pipeline

We are using github-actions for continuous integration and continuous delivery. You can refer the workflows yml to add/update the jobs in the build/deploy workflow yml.

Useful Links

• Swagger UI - for API documentation and testing (LOCAL)
• Swagger YML - Swagger specifications in yml format (LOCAL)
• GitHub Actions - for CI/CD build and deployment
• Application Health Check - Actuator endpoint for application health check (LOCAL)
• E1 Deployment Info - To check last deployed branch and commit id (LOCAL)