Readme updated

Niaktes · Nov 16, 2023 · dedf8ec · dedf8ec
1 parent 1954db1
commit dedf8ec
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,90 @@
 ## job4j_cars
 
-Будем разрабатывать сайт по продаже машин. Ридми обязательно дополню позже!
+В данном проекте разработан сайт для размещения объявлений по продаже машин.
+На данный момент функционал прост: регистрация и авторизация пользователя, просмотр списка объявлений о 
+продаже и каждого объявления отдельно любыми пользователями, добавление и редактирование своих объявлений 
+зарегистрированными пользователями. Также реализован поиск по объявлениям при помощи Criteria API.
 
-##### Предположительно используемые технологии:
+База данных предзаполнена базовыми значениями моделей, корпусов автомобилей, типов коробки передач и т.п. 
+данными. Вся эта информация загружается с помощью **Liquibase** из скриптов (см. db/scripts) при сборке 
+проекта. 
+
+В качестве основного используется **Spring Framework**. <br>
+Страницы разработаны с помощью **Thymeleaf** и **Bootstrap**. Также в проекте используются основные 
+зависимости **PostgreSQL 42.5.4**, **Liquibase 4.15.0** и **Hibernate 5.6.15.**.
+
+### Требования к окружению:
+* Java 17,
+* PostgreSQL 14.0,
+* Apache Maven 3.8.4
+
+### Используемые технологии:
 * Java 17
 * Maven 3.8
-* PostgreSQL 14
-* Spring Boot
+* Spring Boot Starter 3.1.0
+* * Web
+* * Thymeleaf
+* * Test
+* Spring Security Test 6.1.0
+* Hibernate 5.6.15
+* PostgreSQL 14 (driver v.42.5.4)
+* Liquibase 4.15.0
+* H2database 2.1.214
+* Lombok 1.18.28
+* Checkstyle 3.1.2
+
+
 * Junit Jupiter
 * AssertJ
 * Mockito
-* Liquibase 4
-* Sql2o
-* H2database
-* Thymeleaf
 * Bootstrap
-* Checkstyle
 * Log4J
-* IntelliJ IDEA 2022.1.2
 
-### Контакты для связи: 
-> Захаренко Сергей <br>
-email: Sergei.Rabota@gmail.com <br>
-Telegram: @Niaktes <br>
+### Запуск проекта:
+```
+1. Для запуска проекта, Вам необходимо клонировать проект из этого репозитория;
+2. Затем необходимо создать локальную базу данных "cars";
+3. После - пропишите, пожалуйста, логин и пароль к созданной вами базе данных в ресурсные файлы 
+db/liquibase.properties и resorces/hibernate.cfg.xml;
+4. Далее запустите liquibase для предварительного создания таблиц, или смонтируйте проект;
+5. Запустите приложение одним из представленных ниже способов:
+  5.1 Через класс Main, находящийся в папке src\main\java\ru\job4j\cars;
+  5.2 Скомпилировав и запустив проект через maven командой mvn spring-boot:run;
+  5.3 Собрав проект через maven и запустив собранный файл командой java -jar job4j_cars-1.0-SNAPSHOT.jar;
+6. Открыть в браузере страницу http://localhost:8080/index;
+7. Вы великолепны!
+```
+### Доступные страницы:
+**Главная страница, встречающая клиента, с открытой формой поиска и списком объявлений:**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/postsList.png)
+
+**Форма для создания нового объявления (доступно зарегистрированным пользователям):**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/newPost.png)
+
+**Страница объявления с подробным описанием автомобиля:**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/onePost.png)
+
+**Форма для редактирования объявления (доступно зарегистрированным пользователям):**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/postEdit.png)
+
+**Регистрация пользователя:**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/registration.png)
+
+**Авторизация:**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/login.png)
+
+**Список объявлений пользователя:**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/myPosts.png)
+
+**И страница с возможностью отредактировать данные пользователя:**
+![Ой, а где картинка? Я вот тут оставлял, точно помню!](img/userEdit.png)
+
+На этом пока всё...
+#### Искренне благодарю за внимание к моему проекту! И хорошего Вам дня!
+
+### Контакты для связи:
+> <a href="https://github.com/Niaktes/">Захаренко Сергей</a> <br>
+> Телефон: +7 995 299 07 34 <br>
+<a href="https://t.me/Niaktes"><img src="https://seeklogo.com/images/T/telegram-logo-AD3D08A014-seeklogo.com.png" alt="Telegram" height="30"></a>
+<a href="https://wa.me/89265900734"><img src="https://seeklogo.com/images/W/whatsapp-icon-logo-6E793ACECD-seeklogo.com.png" alt="Whatsapp" height="30"></a>
+<a href="mailto:Sergei.Rabota@gmail.com"><img src="https://seeklogo.com/images/G/gmail-logo-0B5D69FF48-seeklogo.com.png" alt="Mail" height="30"></a>
diff --git a/img/login.png b/img/login.png
diff --git a/img/myPosts.png b/img/myPosts.png
diff --git a/img/newPost.png b/img/newPost.png
diff --git a/img/onePost.png b/img/onePost.png
diff --git a/img/postEdit.png b/img/postEdit.png
diff --git a/img/postsList.png b/img/postsList.png
diff --git a/img/registration.png b/img/registration.png
diff --git a/img/userEdit.png b/img/userEdit.png
diff --git a/pom.xml b/pom.xml
@@ -173,7 +173,7 @@
               <goal>shade</goal>
             </goals>
             <configuration>
-              <finalName>application</finalName>
+              <finalName>cars</finalName>
             </configuration>
           </execution>
         </executions>