diff --git a/admin-service/README.md b/admin-service/README.md index 9d8e3b98..b4ed96ed 100644 --- a/admin-service/README.md +++ b/admin-service/README.md @@ -97,3 +97,14 @@ The main dependencies used in this application are: - Azure SDK or GCP SDK: The SDK for the respective cloud provider is used to interact with the Pub-Sub service. For a complete list of dependencies, please refer to the pom.xml file in the project. + +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/0ysfB6Z2/Screenshot-from-2024-01-25-14-02-50.png) diff --git a/car-ui/README.md b/car-ui/README.md index c0ccada7..7866365e 100644 --- a/car-ui/README.md +++ b/car-ui/README.md @@ -4,12 +4,17 @@ This project was generated with [Angular CLI](https://github.com/angular/angular ## Development server +Run `npm install` to install dependencies for a Node.js + Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. ## Code scaffolding Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. +## Car Dashboard + +![Dashboard.png](https://i.postimg.cc/wv4hRqrY/Microsoft-Teams-image-10.png) ## Build Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. @@ -61,3 +66,15 @@ To place an order, the `/order` endpoint of the OrderApplication is called. When - Remove from Cart: `http://localhost:9094/cart/remove` - Add to Cart: `http://localhost:9094/cart/add` +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/SN2SvRR5/Screenshot-from-2024-01-25-14-04-41.png) + + diff --git a/cart-service/README.md b/cart-service/README.md index e8754a96..35a248b3 100644 --- a/cart-service/README.md +++ b/cart-service/README.md @@ -47,6 +47,17 @@ curl --location 'http://localhost:9094/cart/get' \ "userId": "1652" }' ``` +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/C10ymMt3/Screenshot-from-2024-01-25-14-07-21.png) + ### Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. diff --git a/cloud-function/gcpcarfunction/README.md b/cloud-function/gcpcarfunction/README.md index 10ae79f0..823785bb 100644 --- a/cloud-function/gcpcarfunction/README.md +++ b/cloud-function/gcpcarfunction/README.md @@ -53,3 +53,14 @@ After deploying the cloud function, publish a message to the configured topic. ### Monitoring Execution and Error Logs Check the logs to monitor the execution and any error messages on the cloud function. + Open the Firestore service and navigate to the configured collection to check the stored data. + +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/6pSz9Hfz/Screenshot-from-2024-01-25-14-09-04.png) diff --git a/elastic-search/README.md b/elastic-search/README.md index a03c59e8..93477d83 100644 --- a/elastic-search/README.md +++ b/elastic-search/README.md @@ -35,6 +35,16 @@ docker compose up -d ```bash mvn springboot:run --Dspring-boot.run.profiles=azure ``` +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/66mhVjDK/Screenshot-from-2024-01-25-14-10-51.png) ## Contributing diff --git a/inventory-service/README.md b/inventory-service/README.md index 991ddd19..984e1f36 100644 --- a/inventory-service/README.md +++ b/inventory-service/README.md @@ -24,6 +24,16 @@ inventory-service > mvn clean springboot:run ``` curl --location 'http://localhost:9091/products/product/199' ``` +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/x169kQbn/Screenshot-from-2024-01-25-13-49-35.png) ## Contributing diff --git a/order-service/README.md b/order-service/README.md index 0dd24a19..385c1653 100644 --- a/order-service/README.md +++ b/order-service/README.md @@ -36,6 +36,18 @@ curl --location 'http://localhost:9090/orders/1652' Saga orchestration is a design pattern in distributed systems where car-demo process is broken down into a series of smaller, independent transactions (sagas) that can be orchestrated to ensure consistency and reliability across the entire process. ![saga.png](..%2Fdocumentation%2Fsaga.png) + +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/vTbtqTW6/Screenshot-from-2024-01-25-14-12-20.png) + ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. diff --git a/payment-service/README.md b/payment-service/README.md index e8f5b15c..9fbb20f8 100644 --- a/payment-service/README.md +++ b/payment-service/README.md @@ -14,4 +14,21 @@ local-dev > docker compose up -d - Run the application ``` payment-service > mvn clean springboot:run -``` \ No newline at end of file +``` + +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/B6MBzsNY/Screenshot-from-2024-01-25-14-13-50.png) + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +Please make sure to update tests as appropriate. \ No newline at end of file diff --git a/shipment-service/README.md b/shipment-service/README.md index 24bde66e..ec6e7fe9 100644 --- a/shipment-service/README.md +++ b/shipment-service/README.md @@ -40,4 +40,15 @@ Listens for the ShipmentCreatedEvent. ### PubSubPublisherService: Initializes a Google Cloud Pub/Sub publisher during application startup. Publishes shipment data to a Pub/Sub topic. - Gracefully shuts down the publisher during application shutdown. \ No newline at end of file + Gracefully shuts down the publisher during application shutdown. + +## Sonar Configuration + +We have integrated sonar in our project for inspection of code quality to perform automatic reviews with static analysis of code to detect bugs, code smells, and security. + +Execute the following Maven command to run Sonar analysis: +```dtd +mvn clean verify sonar:sonar +``` +### Sonar report +![sonarReport.png](https://i.postimg.cc/pVQmRqHv/Screenshot-from-2024-01-25-14-15-02.png) \ No newline at end of file