YACut

Проект YaCut — это сервис укорачивания ссылок. Его назначение — ассоциировать длинную пользовательскую ссылку с короткой, которую предлагает сам пользователь или предоставляет сервис.

Содержание

• Технологии
• Запуск проекта
• Использование
• Команда проекта

Технологии

• Python 3.12+
• Flask
• Flask-SQLAlchemy
• WTForms

Запуск проекта

Клонируйте репозиторий и перейдите в него:

$ git clone https://github.com/4its/yacut.git && cd yacut

Создайте и активируйте виртуальное окружение(пример команды на Linux):

$ python3 -m venv venv && source venv/bin/activate

Обновите PIP и установите необходимые зависимости:

$ pip install upgrade pip && pip install -r requirements.txt

Создайте файл переменных окружения .env со следующими обязательными параметрами:

FLASK_APP=yacut
FLASK_DEBUG=1
DATABASE_URI=sqlite:///db.sqlite3
SECRET_KEY=YOUR_SUPER_SECRET_KEY

Описание параметров можно найти в файле env_example.

Примените миграции(и создание базы данных):

$ flask db upgrade    

Запуск проекта:

$ Flask run

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

После запуска проекта, Вам будут доступны как Web версия, так и API:

Адрес по умолчанию: http://127.0.0.1:5000

Документацию по API можно посмотреть тут.

Команда проекта

• Georgii Egiazarian