diff --git a/README.md b/README.md index 1eb4be3..dc890a6 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ +# Teacher Diary πŸ“š + +Π’Π΅Π±-ΠΏΡ€ΠΈΠ»ΠΎΠΆΠ΅Π½ΠΈΠ΅ для частных ΠΏΡ€Π΅ΠΏΠΎΠ΄Π°Π²Π°Ρ‚Π΅Π»Π΅ΠΉ β€” ΡƒΠΏΡ€Π°Π²Π»Π΅Π½ΠΈΠ΅ ΡƒΡ‡Π΅Π½ΠΈΠΊΠ°ΠΌΠΈ, Π³Ρ€ΡƒΠΏΠΏΠ°ΠΌΠΈ, расписаниСм ΠΈ взаимодСйствиС с родитСлями. + +## 🎯 ВозмоТности + +### Для прСподаватСля +- **Π£Ρ‡Π΅Π½ΠΈΠΊΠΈ** β€” Π΄ΠΎΠ±Π°Π²Π»Π΅Π½ΠΈΠ΅, Ρ€Π΅Π΄Π°ΠΊΡ‚ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅, привязка ΠΊ родитСлям +- **Π ΠΎΠ΄ΠΈΡ‚Π΅Π»ΠΈ** β€” контактная информация, ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠ° ΠΏΡ€ΠΈΠ³Π»Π°ΡˆΠ΅Π½ΠΈΠΉ Π½Π° email +- **ΠŸΡ€Π΅Π΄ΠΌΠ΅Ρ‚Ρ‹** β€” созданиС ΠΏΡ€Π΅Π΄ΠΌΠ΅Ρ‚ΠΎΠ² для Π³Ρ€ΡƒΠΏΠΏΠΈΡ€ΠΎΠ²ΠΊΠΈ занятий +- **Π“Ρ€ΡƒΠΏΠΏΡ‹** β€” объСдинСниС ΡƒΡ‡Π΅Π½ΠΈΠΊΠΎΠ² ΠΏΠΎ ΠΏΡ€Π΅Π΄ΠΌΠ΅Ρ‚Π°ΠΌ, установка Ρ†Π΅Π½Ρ‹ Π·Π° занятиС +- **РасписаниС** β€” Π½Π΅Π΄Π΅Π»ΡŒΠ½Ρ‹ΠΉ ΠΊΠ°Π»Π΅Π½Π΄Π°Ρ€ΡŒ, созданиС занятий, ΠΎΡ‚ΠΌΠ΅Ρ‚ΠΊΠ° ΠΎ ΠΏΡ€ΠΎΠ²Π΅Π΄Π΅Π½ΠΈΠΈ +- **Dashboard** β€” статистика ΠΈ занятия Π½Π° сСгодня + +### Для Ρ€ΠΎΠ΄ΠΈΡ‚Π΅Π»Π΅ΠΉ (планируСтся) +- ΠŸΡ€ΠΎΡΠΌΠΎΡ‚Ρ€ расписания Ρ€Π΅Π±Ρ‘Π½ΠΊΠ° +- Π”ΠΎΠΌΠ°ΡˆΠ½ΠΈΠ΅ задания +- Π˜ΡΡ‚ΠΎΡ€ΠΈΡ занятий + +## πŸ›  Π’Π΅Ρ…Π½ΠΎΠ»ΠΎΠ³ΠΈΠΈ + +| ΠšΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚ | ВСхнология | +|-----------|------------| +| Backend | Java 17+, Spring Boot 3.2 | +| Security | Spring Security (сСссии + Remember Me) | +| Database | PostgreSQL | +| ORM | Spring Data JPA / Hibernate | +| Frontend | Thymeleaf, Bootstrap 5, Bootstrap Icons | +| Build | Maven | + +## πŸ“¦ Установка ΠΈ запуск + +### ВрСбования +- Java 17+ +- PostgreSQL 14+ +- Maven 3.8+ + +### 1. ΠšΠ»ΠΎΠ½ΠΈΡ€ΠΎΠ²Π°Π½ΠΈΠ΅ +```bash +git clone https://github.com/your-username/teacher-diary.git +cd teacher-diary + + docker run -d -p 1025:1025 -p 8025:8025 --name mailhog mailhog/mailhog \ No newline at end of file