Switch to russian authors, update docker scripts, fill README

Author: andrei-punko

README.MD

@@ -14,13 +14,17 @@ Supports CRUD set of operations and R with pagination
 - JDK 21
 
 ## How to build:
-    mvn clean install
+```shell
+mvn clean install
+```
 
-#### Build Docker image with application inside:
-    docker build ./ -t spring-boot-redis-app
+### Build Docker image with application inside:
+```shell
+docker build --no-cache ./ -t spring-boot-redis-app
+```
 
 ## Start application using starting script:
-Use [run-in-docker.bat](./run-in-docker.bat) script
+Use [run-in-docker.bat](run-in-docker.bat) script
 
 ## Start application by running executable jar (Redis should be started before that manually):
     java -jar target/spring-boot-redis-0.0.1-SNAPSHOT.jar \
@@ -50,16 +54,38 @@ http://localhost:9080/swagger-ui/index.html
 
 ## Useful CURL commands:
 - New article addition:  
-`curl -i -H "Accept: application/json" -H "Content-Type: application/json" -d '{ "title": "Some tittle", "text": "Some text", "summary": "bla-bla", "author": "Pushkin" }' -X POST http://localhost:9080/api/v1/articles`
+```shell
+curl -i -H "Accept: application/json" -H "Content-Type: application/json" -d '{ "title": "Some tittle", "text": "Some text", "summary": "bla-bla", "author": "Pushkin" }' -X POST http://localhost:9080/api/v1/articles
+```
 
 - Get existing article:  
-`curl -i http://localhost:9080/api/v1/articles/1`
+```shell
+curl -i http://localhost:9080/api/v1/articles/1
+```
 
 - Update existing article:  
-`curl -i -H "Accept: application/json" -H "Content-Type: application/json" -d '{ "title": "Another tittle" }' -X PATCH http://localhost:9080/api/v1/articles/2`
+```shell
+curl -i -H "Accept: application/json" -H "Content-Type: application/json" -d '{ "title": "Another tittle" }' -X PATCH http://localhost:9080/api/v1/articles/2
+```
+
+- Get all articles:
+```shell
+curl -i http://localhost:9080/api/v1/articles
+```
 
 - Get list of articles with pagination support:  
-`curl -i 'http://localhost:9080/api/v1/articles?size=2&page=4&sort=author.firstName,DESC'`
+```shell
+curl -i 'http://localhost:9080/api/v1/articles?size=2&page=4&sort=author.firstName,DESC'
+```
 
 - Deletion of article:  
-`curl -i -X DELETE http://localhost:9080/api/v1/articles/1`
+```shell
+curl -i -X DELETE http://localhost:9080/api/v1/articles/1
+```
+
+## Run functional tests:
+
+    cd func-test
+    ./gradlew clean build
+
+Check functional test report [here](func-test/build/spock-reports/index.html)

docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3"
-
 services:
   redis:
     image: redis:7.2-alpine
@@ -13,7 +11,7 @@ services:
       - "6379:6379"
 
   spring-boot-redis-app:
-    build: ./
+    image: spring-boot-redis-app
     restart: always
     network_mode: bridge
     container_name: spring-boot-redis-app

src/main/java/by/andd3dfx/templateapp/SpringBootRedisApp.java

@@ -20,38 +20,38 @@ public static void main(String[] args) {
     }
 
     @Override
-    public void afterPropertiesSet() throws Exception {
+    public void afterPropertiesSet() {
         populateDb();
     }
 
     private void populateDb() {
         var article = Article.builder()
                 .id("1")
-                .author("Isaac Sirin")
+                .author("Исаак Сирин")
                 .title("Слова Подвижнические")
                 .summary("Изложение аскетического опыта")
                 .build();
         var article2 = Article.builder()
                 .id("2")
-                .author("Epiktet")
+                .author("Эпиктет")
                 .title("В чем наше благо")
                 .summary("Творения философа-стоика 1го века")
                 .build();
         var article3 = Article.builder()
                 .id("3")
-                .author("John Sonmez")
+                .author("Джон Сонмез")
                 .title("Путь программиста")
                 .summary("Книга о разных аспектах жизни программиста")
                 .build();
         var article4 = Article.builder()
                 .id("4")
-                .author("Ignaty Brianchaninov")
+                .author("Игнатий Брянчанинов")
                 .title("Отечник")
                 .summary("Собрание изречений святых Отцов")
                 .build();
         var article5 = Article.builder()
                 .id("5")
-                .author("Egor Gaidar")
+                .author("Егор Гайдар")
                 .title("Гибель империи")
                 .summary("Рассказ о распаде СССР")
                 .build();

src/main/java/by/andd3dfx/templateapp/persistence/dao/ArticleRepository.java

@@ -6,7 +6,7 @@
 import org.springframework.stereotype.Repository;
 
 /**
- * Check these docs: https://docs.spring.io/spring-data/redis/docs/3.1.6/reference/html/#query-by-example
+ * Check these <a href="https://docs.spring.io/spring-data/redis/docs/3.1.6/reference/html/#query-by-example">docs</a>
  */
 @Repository
 public interface ArticleRepository extends CrudRepository<Article, String>, QueryByExampleExecutor<Article> {