Skip to content
/ YaCut Public

YaCut — Сервис укорачивания ссылок

Notifications You must be signed in to change notification settings

tvules/YaCut

Repository files navigation

image

YaCut — Сократить ссылку

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

🔥 Возможности

  • Генерация коротких ссылок и связь их с исходными длинными ссылками.
  • Переадресация на исходный адрес при обращении к коротким ссылкам.
  • REST API

Технологии

Flask SQLAlchemy Gunicorn Postgres Docker Nginx

⚙ Начало Работы

Чтобы запустить локальную копию проекта, следуйте инструкциям ниже.

⚠ Зависимости

Установка

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

    git clone https://github.com/tvules/YaCut.git
    cd YaCut

Локальный Запуск (Docker)

  1. В корне проекта создай .env файл

    FLASK_APP=yacut
    FLASK_DEBUG=0
    DATABASE_URI="postgresql://postgres:postgres@db:5432/postgres"
    SECRET_KEY=<секретный ключ>
    POSTGRES_USER=postgres
    POSTGRES_PASSWORD=postgres
    *Секретный ключ можно сгенерировать тут
  2. Выполни сборку и запуск контейнеров docker

    cd infra
    docker compose up --build

    После запуска, проект будет доступен по адресу http://localhost/

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

Usage-example

API (Docs: OpenAPI)

  • POST /api/id/
  • GET /api/id/{short_id}/

🛠 Development

  1. Установи зависимости проекта

    pip install -r requirements.txt
  2. В корне проекта создай .env файл

    FLASK_APP=yacut
    FLASK_DEBUG=1
    DATABASE_URI=<URI базы данных, по умолчанию "sqlite:///db.sqlite3">
    SECRET_KEY=<секретный ключ>
  3. Запусти dev-сервер

    flask run

Автор проекта: Ilya Petrukhin