README.md

🇷🇺 Производственный календарь РФ

📅 API для получения производственных календарей РФ (2023–2025) в формате JSON.

🔗 Быстрое, простое и удобное REST API для разработчиков.

---

📚 Содержание

• 🚀 Быстрый старт
• ✨ Особенности проекта
• 📌 Как получить данные
• 🔧 Swagger-документация
• 🔧 Примеры использования
• 🧪 Тестирование
• 🤝 Как внести вклад
• 📄 Лицензия

---

🚀 Быстрый старт

Использование API

curl -H "Content-Type:application/json" -X GET "https://calendar.kuzyak.in/api/calendar/2023"

Локальный запуск

git clone https://github.com/iposho/holidays-calendar-ru.git
cd holidays-calendar-ru
npm install
npm run dev

Docker

cp .env.example .env 
docker build . -t holidays-calendar
docker run -p 5000:5000 holidays-calendar

---

✨ Особенности проекта

• Простой REST API: Данные в формате JSON для легкой интеграции.
• Гибкость: Запросы на день, месяц или весь год.
• Swagger-документация: Удобный интерфейс для просмотра эндпоинтов и тестирования.
• Docker: Быстрое развертывание в контейнере.
• Локальное развертывание: Минимальные требования для запуска API.

---

📌 Как получить данные

📆 Список доступных календарей

GET /api/calendar

📅 Календарь на год

GET /api/calendar/{year}

🎉 Праздничные и сокращенные дни

GET /api/calendar/{year}/holidays

📆 Календарь на месяц

GET /api/calendar/{year}/{month}

📅 Информация о конкретном дне

GET /api/calendar/{year}/{month}/{day}

---

🔧 Swagger-документация

Полная документация доступна по ссылке:
Swagger UI

Вы можете использовать Swagger UI для тестирования и изучения всех доступных маршрутов и их параметров.

---

🔧 Примеры использования

🐍 Python

import requests

response = requests.get("https://calendar.kuzyak.in/api/calendar/2024")
print(response.json())

📜 JavaScript

fetch("https://calendar.kuzyak.in/api/calendar/2024")
  .then((res) => res.json())
  .then((data) => console.log(data));

🐘 PHP

<?php
$response = file_get_contents("https://calendar.kuzyak.in/api/calendar/2024");
$data = json_decode($response, true);
print_r($data);
?>

💻 Curl

curl -H "Content-Type:application/json" -X GET "https://calendar.kuzyak.in/api/calendar/2024"

---

🧪 Тестирование

1. Запуск тестов:

   npm test

2. Покрытие кода:

   npm run test:coverage

---

🤝 Как внести вклад

1. Форкните репозиторий: Fork this repo
2. Создайте ветку:

   git checkout -b my-feature

3. Добавьте изменения и тесты:

   git commit -m "feat: добавил новую фичу"

4. Запушьте изменения:

   git push origin my-feature

5. Создайте пулл-реквест в ветку develop.

---

📄 Лицензия

Этот проект распространяется под лицензией MIT.