README.md

# Simply Task Planner

**Simply Task Planner** — это простое и удобное приложение для планирования ежедневных и еженедельных задач. Проект создан для интеграции с **Telegram Web Apps**, что позволяет пользователю получить доступ к задачам прямо из Telegram, без необходимости в дополнительной авторизации.

---

## 🚀 Функциональность

- 📅 **Планирование задач**:
  - Создание задач на день или неделю.
  - Установка приоритетов и отметка выполнения.
- 🗂️ **Категории задач**:
  - Разделение задач по категориям (работа, личное, учеба и т.д.).
- 🔔 **Уведомления**:
  - Напоминания о важных задачах через Telegram.
- 🔍 **Просмотр задач**:
  - Список задач на текущий день или неделю.
- 🌐 **Доступность**:
  - Работа через Telegram Web App — доступ в один клик из мессенджера.

---

## 🛠️ Стек технологий

### Backend
- **Go (Gin)** — высокопроизводительный веб-фреймворк.
- **PostgreSQL** — реляционная база данных для хранения задач и категорий.
- **Docker** — для упрощения развертывания и изоляции приложения.

### Frontend
- **Vue.js (через Telegram Web App)** — лёгкий фронтенд для удобного взаимодействия с приложением.

### Инфраструктура
- **Docker Compose** — для запуска всех сервисов (backend, frontend, PostgreSQL).
- **NGINX** (опционально) — в качестве реверс-прокси для улучшения производительности и безопасности.

---

## 📂 Структура проекта

```plaintext
simply-task-planner/
├── backend/                  # Backend на Go
│   ├── main.go               # Основной файл сервера
│   ├── go.mod                # Модульный файл для управления зависимостями
│   ├── Dockerfile            # Dockerfile для сборки backend
├── frontend/                 # Frontend на Vue.js
│   ├── src/                  # Исходный код Vue
│   ├── public/               # Статические файлы
│   ├── package.json          # Конфигурация npm
│   ├── Dockerfile            # Dockerfile для сборки frontend
├── docker/                   # Директория для инфраструктурных файлов
│   ├── postgres_data/        # Хранилище данных PostgreSQL
├── docker-compose.yml        # Конфигурация Docker Compose
├── .gitignore                # Игнорируемые файлы и директории для Git
├── README.md                 # Документация проекта

⚙️ Установка и запуск

Требования

• Docker и Docker Compose должны быть установлены.
• Установленный Telegram для работы с Web App.

Шаги для запуска

1. Клонируйте репозиторий:

   git clone https://github.com/your-username/simply-task-planner.git
   cd simply-task-planner
   

2. Запустите приложение через Docker Compose:

   docker-compose up --build -d
   

3. Откройте Web App через Telegram, используя ссылку, предоставленную ботом.

🧩 API (Backend)

1. Получение списка задач

GET /tasks

Пример ответа:

[
  {
    "id": 1,
    "title": "Сделать презентацию",
    "date": "2024-11-23",
    "category": "Работа",
    "completed": false
  }
]

2. Создание задачи

POST /tasks

Тело запроса:

{
  "title": "Позвонить клиенту",
  "date": "2024-11-23",
  "category": "Работа"
}

3. Обновление задачи

PUT /tasks/:id

Тело запроса:

{
  "title": "Позвонить клиенту",
  "completed": true
}

📖 Руководство по разработке

Запуск Backend для разработки

cd backend
go run main.go

Запуск Frontend для разработки

cd frontend
npm install
npm run dev

🗺️ Дорожная карта

1. Поддержка подзадач и чек-листов.
2. Возможность совместного планирования (общие задачи для групп).
3. Интеграция с Google Calendar.

🤝 Вклад в проект

Если вы хотите внести изменения или дополнения: 1. Форкните репозиторий. 2. Создайте новую ветку:

git checkout -b feature-name

1. Внесите изменения и создайте pull request.

📝 Лицензия

Проект распространяется под лицензией MIT. См. файл LICENSE для получения дополнительной информации.

---

### Основные моменты:
1. **Стиль** README ориентирован на разработчиков и пользователей.
2. **Поддержка Telegram Web App** упоминается как основная особенность.
3. Поддерживается полное описание API и дорожной карты проекта.