Add readme and makefile

Author: VictorGotsenko

Makefile

@@ -0,0 +1,16 @@
+.DEFAULT_GOAL := build-run
+
+clean:
+	./gradlew clean
+lint:
+	./gradlew checkstyleMain checkstyleTest
+build:
+	./gradlew clean build
+run:
+	./gradlew run --args='--spring.profiles.active=dev'	
+test:
+	./gradlew test
+report:
+	./gradlew jacocoTestReport	
+
+build-run: build run

README.md

@@ -1,4 +1,34 @@
-### Hexlet tests and linter status:
 [![Actions Status](https://github.com/VictorGotsenko/java-project-99/actions/workflows/hexlet-check.yml/badge.svg)](https://github.com/VictorGotsenko/java-project-99/actions)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=VictorGotsenko_java-project-99&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=VictorGotsenko_java-project-99)
 
-🌐[Task-Manager on Render](https://java-project-99-5u14.onrender.com/welcome)
+## Task manager
+
+This is a application that allows you to track progress towards your goals through task management, like [Redmine](http://www.redmine.org) .
+
+Allows you to create entities such as: password-protected users, tasks, labels and task tags. You can also filter by these parameters.
+
+### See it work
+The UI version is available 🌐[here](https://java-project-99-5u14.onrender.com) , use it to log in:
+```bash
+username: hexlet@example.com
+password: qwerty
+```
+It can be used as a server application without a user interface (backend application).
+ - The API can be found on the [page](https://java-project-99-5u14.onrender.com/swagger-ui/index.html)
+
+### To run locally
+Clone your copy and run
+
+```bash
+# run application in development mode
+make run
+
+# go to http://localhost:8080
+# use username: hexlet@example.com
+# password: qwerty
+```
+
+#### Used technologies:
+ - Backend: Java, Spring Boot,SpringDoc WebMVC UI, LOMBOK, Mapstruct, HikariCP, PostgreSQL, H2database, 
+ - Tests: JUnit, MockWebServer, Instacio, Javacrumbs
+ - Frontend: Vite, React, TS

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
     id("org.springframework.boot") version "3.5.6"
     id("org.springdoc.openapi-gradle-plugin") version "1.9.0"
     id("io.spring.dependency-management") version "1.1.7"
-    id("org.sonarqube") version "6.2.0.5505" //id("org.sonarqube") version "7.0.1.6134"
+    id("org.sonarqube") version "7.0.1.6134"
     id("io.sentry.jvm.gradle") version "5.12.2"
 }
 
@@ -37,55 +37,38 @@ dependencies {
     implementation("org.springframework.boot:spring-boot-starter-security")
     implementation("org.springframework.boot:spring-boot-starter-oauth2-resource-server")
     implementation("org.springframework.boot:spring-boot-devtools")
-
+    //
     implementation("net.datafaker:datafaker:2.5.3")
-
     // SpringDoc OpenAPI Starter WebMVC UI » 2.8.13
     implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.13")
-
-
     // модуль jackson-databind-nullable
     implementation("org.openapitools:jackson-databind-nullable:0.2.6")
-
     // Mapstruct
     implementation("org.mapstruct:mapstruct:1.5.5.Final")
-
     // конфиг  Mapstruct не работает с классами, в которых используется lombok
     // https://ru.stackoverflow.com/questions/1286369
     compileOnly("org.projectlombok:lombok:1.18.38")
     compileOnly("org.mapstruct:mapstruct:1.5.5.Final")
     annotationProcessor("org.projectlombok:lombok-mapstruct-binding:0.2.0")
     annotationProcessor("org.mapstruct:mapstruct-processor:1.5.5.Final")
     annotationProcessor("org.projectlombok:lombok:1.18.38")
-
-
     // DataBase section
     implementation("com.zaxxer:HikariCP:6.3.0")
-
     runtimeOnly("com.h2database:h2")
     implementation("com.h2database:h2:") // database H2 & HikariCP
     // for  driver class: org.postgresql.Driver
     runtimeOnly("org.postgresql:postgresql")
     implementation("org.postgresql:postgresql:42.7.7")
-
+    // *** Tests ***
     testCompileOnly("org.projectlombok:lombok:1.18.38")
     testAnnotationProcessor("org.projectlombok:lombok:1.18.38")
     testAnnotationProcessor("org.mapstruct:mapstruct-processor:1.5.5.Final")
-
+    //
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
-
-    //**** for Test Render
-//    testImplementation(platform("org.junit:junit-bom:6.0.0-M1"))
-//    testImplementation("org.junit.jupiter:junit-jupiter:6.0.0-M1")
-
     // стартёр тестов
     testImplementation("org.springframework.boot:spring-boot-starter-test")
-
     // для аутентификации
     testImplementation("org.springframework.security:spring-security-test")
-    //****
-    // testImplementation("org.springframework:spring-test:6.2.10")
-
     // test JSON struct
     testImplementation("net.javacrumbs.json-unit:json-unit-assertj:4.1.1")
     // Instacio
@@ -136,10 +119,9 @@ sonar {
         property("sonar.projectKey", "VictorGotsenko_java-project-99")
         property("sonar.organization", "victorgotsenko")
         property("sonar.host.url", "https://sonarcloud.io")
-
+        // property("sonar.log.level", "TRACE")
         // Отключаем проверку зависимостей
-        // property("sonar.dependencyVerification.enabled", "false")
-        property("sonar.log.level", "TRACE")
+        property("sonar.dependencyVerification.enabled", "false")
     }
 }