YaCut

Описание

YaCut - cервис укорачивания ссылок, который заменяет длинную ссылку на короткую (до 16 символов). Вариант сокращения может быть задан как самим пользователем, так и сгенерирован автоматически сервисом. Все сокращения уникальны. Реализован Web-интерфейс для пользователей и REST API.

Основные эндпоинты

/ - Web-интерфейс для генерации короткой ссылки

/<short_id>/ - Web-интерфейс для переадресации на исходную ссылку

/api/id/ - POST-запрос к API для генерации короткой ссылки

/api/id/<short_id>/ - GET-запрос для получения исходной ссылки из короткой

Стек технологий

Порядок действий для запуска проекта

1. Клонировать репозиторий и перейти в папку c проектом

git clone git@github.com:ItsFreez/YaCut.git

cd YaCut

2. Cоздать и активировать виртуальное окружение

Для Windows

python -m venv env
source venv/Scripts/Activate

Для MacOS/Linux

python3 -m venv env
source env/bin/activate

3. Обновить менеджер pip и установить зависимости из файла requirements.txt

python -m pip install --upgrade pip

pip install -r requirements.txt

4. Применить миграции для создания базы данных

flask db upgrade

5. Создать файл .env и заполнить по примеру из файла env.example

touch .env

6. Запустить проект

flask run

Автор проекта

ItsFreez