Skip to content

olesmartyniuk/russian-sites-status-api

Repository files navigation

Статус рашистських сайтів

Web API, що дає доступ до статусу рашистських сайтів. Моніторинг відбувається кожні 300 сек з багатьох країн світу, включаючи росію (новосибірськ), за протоколом HTTP.

Це бекенд частина частина для вебсайту, написана на .NET 6.

Початок роботи

Для роботи вам необхідно:

  1. Встановити .NET 6
  2. Встановити Git
  3. Клонувати репозиторій командою

git clone https://github.com/olesmartyniuk/russian-sites-status-api.git

Для запуску веб програми локально виконайте наступні команди в склонованому репозиторії:

  1. dotnet build
  2. dotnet run

Ви повинні побачити наступне повідомлення, що свідчить про успішну компіляцію та запуск проєкту:

Building...
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: https://localhost:7160

Внесення змін в код

Перед початком попросіть власника додати вас як учасника до репозиторію.

  1. Оберіть одну із задач, яка здається вам зрозумілою зі списку і містить мітку should be implemented.
  2. Створіть гілку в репозиторії з іменем задачі.
  3. Напишіть код і протестуйте зміни локально.
  4. Проштовхніть код на сервер і створіть Pull Request в основну гілку.
  5. Після того, як Pull Requst буде злито в основну гілку, перевірте ваші зміни на бойовому сервері: https://russian-sites-status-api.herokuapp.com/

Для тестування змін локально вам необхідно буде встановити StatusCake API Key. Попросіть автора надати цей ключ та інструкцію з його встановлення.

Додавання нових задач

Ви можете запропонувати новий функціонал чи прозвітувати про баг на сторінці Issues.

Оточення

Тестове оточення

Продакш оточення

База даних

Для використання бази даних локально необхідно встановити PostgreSQL або запустити docker контейнер:

docker run --name mordor-sites-status -e POSTGRES_PASSWORD=123 -p 5432:5432 -d postgres

Щоб підключити базу даних локально, необхідно встановити змінну оточення DATABASE_URL і вказати URL підключення до БД.

set DATABASE_URL=postgres://postgres:123@localhost:5432/mordor-sites-status

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •