module
0.0.0-20240731175411-05420a5990b4
Repository: https://github.com/leerwitz/projecttodo.git
Documentation: pkg.go.dev
# README
Project To do
Содержание:
- Краткое описание
- Установка локально
- Проект на удаленном сервере
- Создание и запуск Docker контейнера
- Использование
Краткое описание
Проект представляет собой сайт на котором можно оставлять какие то задачи как напоминание. Сама задача разделена на несколько частей:
- Заголовок
- Текст
- Автор
- Срочное оно или не срочное
- ID Задание можно создать, удалить и редактировать. Также реализован поиск по заголовку и по ID (прим. поиск по ID всегда следует начинать с) Сервер реализован по Restful api, для задач реализован CRUD.
Установка локально
Если вы не хотите устанавливать проект локально, то можете посмотреть его здесь https://leerwitz.ru
На устройстве должен быть установлен Docker версии
Установка Docker:
На Linux(ubuntu)
Шаг 1: Удалите старые версии Docker (если они установлены)
sudo apt-get remove docker docker-engine docker.io containerd runc
Шаг 2: Обновите индекс пакетов и установите необходимые пакеты для установки через HTTPS
sudo apt-get update
sudo apt-get install \
ca-certificates \
curl \
gnupg \
lsb-release
Шаг 3: Добавьте официальный GPG ключ Docker
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
Шаг 4: Добавьте репозиторий Docker в источники APT
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
Шаг 5: Обновите индекс пакетов и установите Docker Engine
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
Шаг 6: Проверьте, что Docker установлен корректно
sudo docker run hello-world
Если вы увидите сообщение "Hello from Docker!", значит Docker установлен и работает правильно.
На Windows
Шаг 1: Проверьте системные требования
Перед установкой Docker убедитесь, что ваша система соответствует следующим требованиям:
- Windows 10 64-бит: Pro, Enterprise, или Education (Build 16299 или выше) или Windows 11.
- Включённая функция Hyper-V и контейнеры Windows.
Шаг 2: Скачайте Docker Desktop
- Перейдите на официальный сайт Docker и скачайте установочный файл Docker Desktop: Docker Desktop для Windows.
Шаг 3: Установите Docker Desktop
- Запустите скачанный установочный файл
Docker Desktop Installer.exe
. - Следуйте инструкциям установщика. По умолчанию будут установлены все необходимые компоненты.
Шаг 4: Настройте Docker Desktop
- После завершения установки запустите Docker Desktop.
- При первом запуске Docker Desktop предложит вам включить необходимые функции Windows, такие как Hyper-V и контейнеры. Нажмите "Ok", чтобы разрешить изменения.
- Перезагрузите компьютер, если это потребуется.
Шаг 5: Проверьте установку Docker
- После перезагрузки запустите Docker Desktop.
- Откройте командную строку (CMD) или PowerShell и выполните команду:
docker --version
- Выполните тестовый запуск контейнера:
docker run hello-world
Если вы увидите сообщение "Hello from Docker!", значит Docker установлен и работает правильно.
На MacOS
Шаг 1: Проверьте системные требования
Перед установкой Docker убедитесь, что ваша система соответствует следующим требованиям:
- macOS версии 10.15 или выше.
- Аппаратная виртуализация должна быть включена в настройках BIOS.
Шаг 2: Скачайте Docker Desktop
- Перейдите на официальный сайт Docker и скачайте установочный файл Docker Desktop для Mac: Docker Desktop для Mac.
Шаг 3: Установите Docker Desktop
- Откройте скачанный файл
Docker.dmg
. - Перетащите Docker в папку "Applications".
Шаг 4: Запустите Docker Desktop
- Откройте Docker из папки "Applications".
- При первом запуске Docker Desktop может запросить доступ к системным настройкам для установки необходимых компонентов. Нажмите "Ok" и введите свой пароль администратора.
Шаг 5: Настройте Docker Desktop
- Следуйте инструкциям на экране для завершения настройки Docker Desktop.
- После завершения настройки вы увидите значок Docker в строке меню.
Шаг 6: Проверьте установку Docker
- Откройте терминал (Terminal).
- Введите команду:
docker --version
- Выполните тестовый запуск контейнера:
docker run hello-world
Если вы увидите сообщение "Hello from Docker!", значит Docker установлен и работает правильно.
Создание и запуск Docker контейнера
Зайдите в корневую директорию проекта(projectToDo) и введите в терминал:
sudo docker-compose up -d --build
Чтобы удалить контейнер введите:
sudo docker-compose down
Чтобы посмотреть логи контейнера используйте:
sudo docker-compose logs
Использование
После сборки контейнер зайдите на http://localhost в браузере, теперь вы можете начать пользоваться приложением.