https://github.com/mx4alex/taskmanager

📋REST API service for working with tasks written on Go
https://github.com/mx4alex/taskmanager

clean-architecture docker gin go golang-api grpc makefile postgresql rest-api sql sqlite

Last synced: 9 days ago
JSON representation

📋REST API service for working with tasks written on Go

• Host: GitHub
• URL: https://github.com/mx4alex/taskmanager
• Owner: mx4alex
• Created: 2023-07-20T09:53:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-01T16:14:24.000Z (about 1 year ago)
• Last Synced: 2023-09-02T14:23:14.903Z (about 1 year ago)
• Topics: clean-architecture, docker, gin, go, golang-api, grpc, makefile, postgresql, rest-api, sql, sqlite
• Language: Go
• Homepage:
• Size: 14.2 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TaskManager

REST API сервис для работы с задачами, написанный на языке Go

## Установка и конфигурация

- Склонировать репозиторий:

  ```

  git clone https://github.com/mx4alex/TaskManager.git

  ```

- Настроить конфигурацию в файле `config.yaml`

- Запустить *docker compose*

  ```

  docker compose up --build

  ```

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

### Сервис поддерживает следующие эндпоинты:

- `POST /tasks` создает задачу, которая передана в *body* 

- `GET /tasks` возвращает все задачи

- `PUT /tasks/{id}/mark` помечает задачу с заданным *id* выполненной

- `PUT /tasks/{id}` изменяет задачу с заданным *id* на задачу, которая передана в *body*

- `DELETE /tasks/{id}` удаляет задачу с заданным *id*

Документация находится в папке docs

Визуальная документация Swagger UI доступна по адресу [`http://localhost:8080/swagger/index.html#`](http://localhost:8080/swagger/index.html#)

## Вариации интерфейса

- CLI

- REST API

- GRPC

## Вариации хранилища задач

- memory

- SQLite

- PostgreSQL