From 1a993da21134dc8f45cad3dc30ff98e6c8edd519 Mon Sep 17 00:00:00 2001 From: DmitriyVladarchuk Date: Wed, 17 Sep 2025 12:14:37 +0300 Subject: [PATCH] feat: Added README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..80825cc --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Financial Tracker API + +Простое RESTful API для управления личными финансами, написанное на ASP.NET Core. + +## 🚀 Возможности + +- **Управление категориями** - Полный CRUD для категорий доходов/расходов +- **Управление транзакциями** - Создание, чтение, обновление и удаление финансовых операций +- **Валидация данных** - Проверка входных данных и обработка ошибок +- **RESTful архитектура** - Соответствие стандартам REST API + +## 🛠️ Стек + +- **ASP.NET Core 9.0** - Веб-фреймворк +- **Entity Framework Core 9.0** - ORM для работы с базой данных +- **PostgreSQL** - Реляционная база данных +- **Npgsql** - PostgreSQL провайдер для EF Core +- **xUnit** - Фреймворк для unit-тестирования +- **Moq** - Mocking библиотека для тестов +- **GitHub Actions** - CI пайплайн + +## 📚 API Endpoints + +### Категории +- `GET /api/categories` - Получить все категории +- `GET /api/categories/{id}` - Получить категорию по ID +- `POST /api/categories` - Создать новую категорию +- `PUT /api/categories` - Обновить категорию +- `DELETE /api/categories/{id}` - Удалить категорию + +### Транзакции +- `GET /api/transactions` - Получить все транзакции +- `GET /api/transactions/{id}` - Получить транзакцию по ID +- `POST /api/transactions` - Создать новую транзакцию +- `PUT /api/transactions` - Обновить транзакцию +- `DELETE /api/transactions/{id}` - Удалить транзакцию