https://github.com/gitkodev/django_effective-team
Effective team project
https://github.com/gitkodev/django_effective-team
Last synced: 3 months ago
JSON representation
Effective team project
- Host: GitHub
- URL: https://github.com/gitkodev/django_effective-team
- Owner: gitkoDev
- Created: 2024-04-22T09:54:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T11:05:41.000Z (over 1 year ago)
- Last Synced: 2025-01-20T21:57:01.674Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Effective team REST API
Rest API с использованием `Django` и `Django Rest Framework`
## Сущности
1. Creator
2. Team
3. Member
4. Request
5. Transaction
## Endpoints
#### CRUD операции
- /api/***имя_сущности***/ `=>` **POST** `=>` Добавить сущность (`creator`/`team`/`member`/`request`)
- /api/***имя_сущности***/ `=>` **GET** `=>` Получить все сущности (`creator`/`team`/`member`/`request`)
- /api/***имя_сущности***/***id***/ `=>` **GET** `=>` Получить сущность по id (`creator`/`team`/`member`/`request`)
- /api/***имя_сущности***/***id***/ `=>` **PUT** `=>` Обновить сущность (`creator`/`team`/`member`/`request`)
- /api/***имя_сущности***/***id***/ `=>` **DELETE** `=>` Удалить сущность (`creator`/`team`/`member`/`request`)
#### Операции с транзакциями
- /api/***transactions***/ `=>` **GET** `=>` Получить все транзакции
- /api/***transactions***/ `=>` **POST** `=>` Осуществить транзакцию
#### Операции с запросами на вступленние в комманды
- /api/***teams***/***id***/request `=>` **GET** `=>` Получить все запросы в команду
- /api/***teams***/***id***/request `=>` **POST** `=>` Отправить запрос в команду
- /api/***teams***/***id***/recruit `=>` **POST** `=>` Принять в команду участников (отбор по выносливости в случае ограниченного количества мест в групппе)
## Swagger документация по доступным эндпоинтам
- /api/schema/swagger-ui/ `=>` **GET**
- /api/schema/redoc/ `=>` **GET**
## Запуск
Первоначальный запуск для установки всех небходимых зависимостей и миграций
```
make initUp
```
Повторный запуск
```
make up
```