(Rus) ToDoApp

Веб-сервис, реализованный на React, FastAPI и PostgreSQL. Служит для создания, изменения, хранения и удобной организации пользовательских заметок. Возможности на данный момент:

• Аутентификация пользователя по почте + паролю с верификацией почты
• Создание, обновление, удаление, получение заметок
• Статусы заметок: выполненные, невыполненные и удаленные
• Пользовательские теги для заметок: важное, любимое и любые другие, созданные пользователем
• Обновление почты, пароля, никнейма

Как запустить

Для запуска потребуется установленный docker

1 способ:

1. Установить репозиторий к себе на устройство и запустить термина из директории, куда он был установлен
2. Запустить билд образа API, фронта:

   docker compose build

3. Подтянуть образ postgres:

   docker image pull postgres:latest

4. Запустить сервис:

   docker compose up -d

2 способ:

1. Скачать файл docker-compose.yml и запустить терминал из директории, куда он был установлен
2. Подтянуть необходимые образы:

   docker compose pull

3. Запустить сервис:

   docker compose up -d

После запуска сервер будет находиться по адресу: http://localhost:5173

Дополнительные настройки

.env файл задан по умолчанию с базовыми настройками и отключенной верификацией почты
Для включения верификации, см. документацию google. После настройки в .env изменить:

VERIFICATION_ENABLED = "True"

EMAIL_USER = "<ваша почта>"

EMAIL_PASSWORD = "<специальный пароль для доступа к Gmail API>"

(Eng) ToDoApp

A web service built on React, FastAPI, and PostgreSQL. It allows you to create, edit, store, and easily organize user notes. Current features:

• User authentication via email and password with email verification
• Create, update, delete, and retrieve notes
• Note statuses: completed, uncompleted, and deleted
• Custom tags for notes: important, favorite, and any other tags created by the user
• Update email, password, and nickname

How to run

Docker must be installed to run.

1 way:

1. Istall the repository to your device and run terminal from directory where it was installed.
2. Run the API and front image builds:

docker compose build

3. Pull the postgres image:

docker image pull postgres:latest

4. Launch service:

docker compose up -d

2 way:

1. Install file docker-compose.yml and run terminal from directory where it was installed
2. Pull the neccessary images:

docker compose pull

3. Launch service:

docker compose up -d

After starting, the server will be located at: http://localhost:5173

Additional settings

The .env file is set by default with basic settings and email verification disabled
To enable verification, see the google documentation. After configuring, change the following in .env:

VERIFICATION_ENABLED = "True"

EMAIL_USER = ""

EMAIL_PASSWORD = ""