Skip to content

Commit 98590eb

Browse files
committed
update MANUAL.md and README.md
1 parent 049ec88 commit 98590eb

File tree

3 files changed

+33
-2
lines changed

3 files changed

+33
-2
lines changed

MANUAL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ PASSWORD_VALIDATOR value as follows:
3939

4040
```^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#&()–[{}]:;',?/*~$^+=<>]).{8,32}$```
4141

42+
Password requirement: 8-32 chars, at least 1 uppercase, 1 lowercase, 1 number, 1 special char
4243

4344
# Created by:
4445

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![img.png](src/main/resources/static/readme/banner-app.png)
22

3-
# We use server port: 8081
3+
# We use server port: 8081 & our Website is responsive!
44

55
## Hosting plan
66

@@ -21,7 +21,15 @@
2121
- MySQL
2222
- Spring Security
2323
- Log4j2
24+
- Validator
25+
26+
## Frontend Dependencies
27+
2428
- ThymeLeaf
29+
- Bootstrap 5
30+
- Html
31+
- CSS
32+
- JavaScript
2533

2634
## Test Dependencies
2735

@@ -31,11 +39,33 @@
3139
- Spring Boot Test
3240
- Spring Boot Starter Test
3341
- Spring Boot Test Autoconfigure
42+
- REST endpoints tested with Postman
3443

3544
## Basic setup
3645

3746
- See manual
3847

48+
## Basic coding rules
49+
50+
- Clean code (code readability in main the focus)
51+
- OOP principles
52+
- SOLID principles
53+
- MVC pattern
54+
- 3-tier architecture (Repository, Service, Controller layers)
55+
- Common Error handling
56+
- Creating separate REST API and Controller for Thymeleaf
57+
- Uniform endpoints
58+
- Collaboration on GitHub (branching, pull requests, code review)
59+
60+
## Future plan
61+
62+
- Create separate table for roles (and set a list of roles to the users)
63+
- We plan to use our existing domain: csaba79coder.com
64+
- We plan to make registration with social media
65+
- We also plan to make a mobile app (and using google map's API there for the localization of the users)
66+
3967
# Created by:
4068

41-
![img_1.png](src/main/resources/static/readme/banner-team.png)
69+
![img_1.png](src/main/resources/static/readme/banner-team.png)
70+
71+
![img.png](src/main/resources/static/readme/indexPage.png)
1.04 MB
Loading

0 commit comments

Comments
 (0)