diff --git a/README.md b/README.md index 7240d15..5a28f10 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,61 @@ -# JOBot +# JoBot πŸ€– -Telegram platform for hh.ru because IT is circus \ No newline at end of file +Telegram-Π±ΠΎΡ‚ для Π°Π²Ρ‚ΠΎΠΌΠ°Ρ‚ΠΈΠ·Π°Ρ†ΠΈΠΈ поиска Ρ€Π°Π±ΠΎΡ‚Ρ‹ Ρ‡Π΅Ρ€Π΅Π· HeadHunter API. +ΠŸΠΎΠΌΠΎΠ³Π°Π΅Ρ‚ соискатСлям ΡƒΠΏΡ€Π°Π²Π»ΡΡ‚ΡŒ ΠΎΡ‚ΠΊΠ»ΠΈΠΊΠ°ΠΌΠΈ ΠΈ ΠΏΠΎΠ»ΡƒΡ‡Π°Ρ‚ΡŒ Π°ΠΊΡ‚ΡƒΠ°Π»ΡŒΠ½Ρ‹Π΅ вакансии. + +## πŸ”₯ ВозмоТности + +- **Авторизация Ρ‡Π΅Ρ€Π΅Π· HH** + ΠŸΡ€ΠΈΠ²ΡΠΆΠΈΡ‚Π΅ Π°ΠΊΠΊΠ°ΡƒΠ½Ρ‚ HeadHunter для доступа ΠΊ Ρ€Π΅Π·ΡŽΠΌΠ΅ ΠΈ вакансиям. +- **Π£ΠΌΠ½Ρ‹Π΅ ΠΎΡ‚ΠΊΠ»ΠΈΠΊΠΈ** + АвтоматичСская ΠΎΡ‚ΠΏΡ€Π°Π²ΠΊΠ° ΠΎΡ‚ΠΊΠ»ΠΈΠΊΠΎΠ² Π½Π° подходящиС вакансии. +- **ΠŸΡ€ΠΎΠ²Π΅Ρ€ΠΊΠ° Ρ€Π΅Π·ΡŽΠΌΠ΅** + УвСдомлСния, Ссли Ρ€Π΅Π·ΡŽΠΌΠ΅ Ρ‚Ρ€Π΅Π±ΡƒΠ΅Ρ‚ обновлСния. +- **Аналитика** + Бтатистика ΠΏΠΎ ΠΎΡ‚ΠΊΠ»ΠΈΠΊΠ°ΠΌ ΠΈ ΠΏΡ€ΠΈΠ³Π»Π°ΡˆΠ΅Π½ΠΈΡΠΌ. + +## πŸ›  Π’Π΅Ρ…Π½ΠΎΠ»ΠΎΠ³ΠΈΠΈ + +- **Backend**: .NET 8 + gRPC +- **Π‘Π°Π·Π° Π΄Π°Π½Π½Ρ‹Ρ…**: PostgreSQL +- **Авторизация**: OAuth 2.0 (HH API) +- **Π˜Π½Ρ„Ρ€Π°ΡΡ‚Ρ€ΡƒΠΊΡ‚ΡƒΡ€Π°**: Docker + Kubernetes (ΠΎΠΏΡ†ΠΈΠΎΠ½Π°Π»ΡŒΠ½ΠΎ) + +## πŸš€ Запуск + +### ВрСбования +- .NET 8 SDK +- Docker (для Ρ€Π°Π±ΠΎΡ‚Ρ‹ с Π‘Π”) +- Аккаунт Ρ€Π°Π·Ρ€Π°Π±ΠΎΡ‚Ρ‡ΠΈΠΊΠ° Π½Π° [dev.hh.ru](https://dev.hh.ru) + +### 1. Настройка ΠΊΠΎΠ½Ρ„ΠΈΠ³ΡƒΡ€Π°Ρ†ΠΈΠΈ +Π‘ΠΎΠ·Π΄Π°ΠΉΡ‚Π΅ `appsettings.json` Π² `JOBot.TClient` Π½Π° основС `appsettings.Example.json` + +### 2. Запуск Ρ‡Π΅Ρ€Π΅Π· Docker + +docker-compose up -d +dotnet run --project JoBot.Backend +dotnet run --project JoBot.Client + +## πŸ“Œ ΠšΠΎΠΌΠ°Π½Π΄Ρ‹ Π±ΠΎΡ‚Π° +|Команда|ОписаниС| +|-------|--------| +|/start |Начало Ρ€Π°Π±ΠΎΡ‚Ρ‹ +|/connect_hh|ΠŸΡ€ΠΈΠ²ΡΠ·Π°Ρ‚ΡŒ Π°ΠΊΠΊΠ°ΡƒΠ½Ρ‚ HH +|/jobs |Поиск вакансий +|/profile|ΠŸΡ€ΠΎΠ²Π΅Ρ€ΠΈΡ‚ΡŒ Ρ€Π΅Π·ΡŽΠΌΠ΅ +|/stats |Бтатистика ΠΎΡ‚ΠΊΠ»ΠΈΠΊΠΎΠ² + +## πŸ”’ Π‘Π΅Π·ΠΎΠΏΠ°ΡΠ½ΠΎΡΡ‚ΡŒ +Π’ΠΎΠΊΠ΅Π½Ρ‹ ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Π΅ΠΉ ΡˆΠΈΡ„Ρ€ΡƒΡŽΡ‚ΡΡ (AES-256) + +ВсС Π΄Π°Π½Π½Ρ‹Π΅ ΠΏΠ΅Ρ€Π΅Π΄Π°ΡŽΡ‚ΡΡ Ρ‡Π΅Ρ€Π΅Π· HTTPS + +πŸ“„ ЛицСнзия +MIT License. ΠŸΠΎΠ΄Ρ€ΠΎΠ±Π½Π΅Π΅ Π² Ρ„Π°ΠΉΠ»Π΅ LICENSE. + +## ΠžΡ‚ΠΊΠ°Π· ΠΎΡ‚ отвСтствСнности + +ΠŸΡ€ΠΎΠ΄ΠΎΠ»ΠΆΠ°Ρ, Π²Ρ‹ ΠΏΡ€ΠΈΠ½ΠΈΠΌΠ°Π΅Ρ‚Π΅ [ΠΏΠΎΠ»ΠΈΡ‚ΠΈΠΊΡƒ ΠΊΠΎΠ½Ρ„ΠΈΠ΄Π΅Π½Ρ†ΠΈΠ°Π»ΡŒΠ½ΠΎΡΡ‚ΠΈ](https://hh.ru/article/personal_data?backurl=%2F&role=applicant) ΠΈ [ΠΏΡ€Π°Π²ΠΈΠ»Π° сСрвиса](https://hh.ru/account/agreement?backurl=%2Faccount%2Fsignup%3Fbackurl%3D%252F%26role%3Dapplicant&role=applicant) hh.ru + +Π­Ρ‚ΠΎΡ‚ сСрвис Π½ΠΈΠΊΠ°ΠΊ Π½Π΅ связан с HeadHunterβ„’ (Π΄Π°Π»Π΅Π΅ hh.ru), Π½Π΅ Π²Ρ‹Π΄Π°Ρ‘Ρ‚ сСбя Π·Π° hh.ru ΠΈ Π½Π΅ являСтся hh.ru \ No newline at end of file