Feature/task 4960 test build project

README.md

@@ -4,35 +4,44 @@ The full documentation on Amido Stacks can be found [here](https://amido.github.
 
 ### Customised solution
 
-To customise the namespaces and create an application for your company please visit the full [documentation](https://stacks.amido.com/docs/)
+To customise the namespaces and create an application for your company please visit the
+full [documentation](https://stacks.amido.com/docs/)
 
 ### Running the application locally
 
 1. Clone one of the Java projects to your local machine from one of the following repos:
    ---
     1. Simple web API: [stacks-java repository](https://github.com/amido/stacks-java)
     2. Web API with CQRS: [stacks-java-cqrs repository](https://github.com/amido/stacks-java-cqrs)
-    3. Web API with CQRS and events: [stacks-java-cqrs-events repository](https://github.com/amido/stacks-java-cqrs-events)
+    3. Web API with CQRS and
+       events: [stacks-java-cqrs-events repository](https://github.com/amido/stacks-java-cqrs-events)
 
 2. Configure required environment variables
    ---
    The application is currently configured to work with the Azure environment.
 
-   It uses an Azure **CosmosDB** database to store the example application data. So you should have access to an instance to use with the application.
-   Note: For running on a local Windows environment you can use the [Cosmos DB emulator](docs/workloads/azure/backend/java/setting_up_cosmos_db_locally_java.md) (CosmosDB Emulator has a known fixed key). There is no need for CosmosDB for the simple web API implementation (1.i above) as there is no persistence layer in it.
-   For further info please follow the [link](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator?tabs=ssl-netstd21).
+   It uses an Azure **CosmosDB** database to store the example application data. So you should have
+   access to an instance to use with the application. Note: For running on a local Windows
+   environment you can use
+   the [Cosmos DB emulator](docs/workloads/azure/backend/java/setting_up_cosmos_db_locally_java.md) (
+   CosmosDB Emulator has a known fixed key). There is no need for CosmosDB for the simple web API
+   implementation (1.i above) as there is no persistence layer in it. For further info please follow
+   the [link](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator?tabs=ssl-netstd21).
 
    ---
 
-   In addition, Azure **ApplicationInsights** is used for logging purposes. If this is unavailable, modify the application so that it doesn't fail to startup if it can't access ApplicationInsights, and simply log to the terminal instead.
+   In addition, Azure **ApplicationInsights** is used for logging purposes. If this is unavailable,
+   modify the application so that it doesn't fail to startup if it can't access ApplicationInsights,
+   and simply log to the terminal instead.
 
     ```yaml
        application-insights:
            instrumentation-key: xxxxxx
            enabled: false
     ```
 
-   There are two corresponding environment variables that need to be set to interact with these systems:
+   There are two corresponding environment variables that need to be set to interact with these
+   systems:
 
     ```text
     AZURE_COSMOSDB_KEY
@@ -65,19 +74,22 @@ To customise the namespaces and create an application for your company please vi
     mvnw.cmd spring-boot:run
     ```
 
-   For instructions on how to customise the project for your company please look in the [Scaffolding](docs/workloads/azure/backend/java/scaffolding_java.md) section
+   For instructions on how to customise the project for your company please look in
+   the [Scaffolding](docs/workloads/azure/backend/java/scaffolding_java.md) section
 
 4. Build and run the application using Cosmos DB Emulator
    ---
-   Please refer to section "Determine which root certificates have been installed" in [Setting Up CosmosDB Emulator](docs/workloads/azure/backend/java/setting_up_cosmos_db_locally_java.md)
+   Please refer to section "Determine which root certificates have been installed"
+   in [Setting Up CosmosDB Emulator](docs/workloads/azure/backend/java/setting_up_cosmos_db_locally_java.md)
 
-   Move to the `<PROJECT-NAME>/java` folder, then
-   go to `application.yml` either comment out the `application-insights` block or set `enabled`  property to `false`.
-   In `logback-spring.xml` comment out the application-insight section.
+   Move to the `<PROJECT-NAME>/java` folder, then go to `application.yml` either comment out
+   the `application-insights` block or set `enabled`  property to `false`. In `logback-spring.xml`
+   comment out the application-insight section.
 
    ![logback](/img/logback_xml.png)
 
-   Set `AZURE_COSMOSDB_KEY` as an environment variable and set the value to be the primary key value on the emulator.
+   Set `AZURE_COSMOSDB_KEY` as an environment variable and set the value to be the primary key value
+   on the emulator.
    <br />
 
    For UNIX systems do:
@@ -94,38 +106,45 @@ To customise the namespaces and create an application for your company please vi
 
 5. Verify that the application has started
    ---
-   Browse to [http://localhost:9000/v1/menu](http://localhost:9000/v1/menu). This should return a valid JSON response.
+   Browse to [http://localhost:9000/v1/menu](http://localhost:9000/v1/menu). This should return a
+   valid JSON response.
 
-   The application configuration uses Swagger/OAS3 to represent the API endpoints. The Swagger UI can be viewed by directing your
-   browser to [http://localhost:9000/swagger/index.html](http://localhost:9000/swagger/index.html).
+   The application configuration uses Swagger/OAS3 to represent the API endpoints. The Swagger UI
+   can be viewed by directing your browser
+   to [http://localhost:9000/swagger/index.html](http://localhost:9000/swagger/index.html).
 
 ### Authorization
 
-All API endpoints are (optionally) protected using **Auth0**. There is an `auth.properties` file within the project codebase.
-If the following property within this file is set:
+All API endpoints are (optionally) protected using **Auth0**. There is an `auth.properties` file
+within the project codebase. If the following property within this file is set:
 
 ```text
 auth.isEnabled=true
+
 ```
 
-then clients will need to pass an `Authorization` header containing the Bearer token generated from Auth0 as part of the endpoint request. If the value
-is set to `false` then no authorization is required.
+then clients will need to pass an `Authorization` header containing the Bearer token generated from
+Auth0 as part of the endpoint request. If the value is set to `false` then no authorization is
+required.
 
 #### Auth0 configuration properties
 
-If using Auth0 for authorization, Auth0 itself will need to be configured with both an API definition and an associated Application.
-There are corresponding configuration values required for the Stacks application, within the `auth.properties` file, e.g.
+If using Auth0 for authorization, Auth0 itself will need to be configured with both an API
+definition and an associated Application. There are corresponding configuration values required for
+the Stacks application, within the `auth.properties` file, e.g.
 
 ```text
 auth0.issuer=https://amidostacks.eu.auth0.com/
 auth0.apiAudience=https://amidostacks.eu.auth0.com/api/v2/
 ```
 
-These parameters are used to verify that the JWT supplied in the Authorization header of a request is valid.
+These parameters are used to verify that the JWT supplied in the Authorization header of a request
+is valid.
 
 #### Swagger/OAS
 
-- Automatically generated for the project. Go to [Swagger Index](http://localhost:9000/swagger/index.html) to view.
+- Automatically generated for the project. Go
+  to [Swagger Index](http://localhost:9000/swagger/index.html) to view.
 - Swagger Json is here: [Swagger Json](http://localhost:9000/swagger/oas.json)
 
 #### Health check
@@ -145,7 +164,8 @@ From the `<PROJECT-NAME>/java` folder, build a Docker image using e.g. the comma
 
 This uses the `Dockerfile` in this folder to generate the Docker image.
 
-If you have an `.m2` directory in the `java/` folder, the Docker build will attempt to copy the files inside the container and use the cached versions.
+If you have an `.m2` directory in the `java/` folder, the Docker build will attempt to copy the
+files inside the container and use the cached versions.
 
 Once the Docker image is created, you can then run a Docker container based on this image using e.g.