{"id":21522292,"url":"https://github.com/andmerk93/yacut","last_synced_at":"2026-05-21T10:02:10.891Z","repository":{"id":182815889,"uuid":"667908112","full_name":"andmerk93/yacut","owner":"andmerk93","description":"Flask + Jinja2 + SQLAlchemy","archived":false,"fork":false,"pushed_at":"2023-09-07T14:12:12.000Z","size":211,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-24T04:52:23.081Z","etag":null,"topics":["flask","jinja2","python","sqlalchemy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andmerk93.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-07-18T15:12:09.000Z","updated_at":"2023-10-10T13:31:33.000Z","dependencies_parsed_at":"2023-07-21T15:23:42.904Z","dependency_job_id":null,"html_url":"https://github.com/andmerk93/yacut","commit_stats":null,"previous_names":["andmerk93/yacut"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmerk93%2Fyacut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmerk93%2Fyacut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmerk93%2Fyacut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmerk93%2Fyacut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andmerk93","download_url":"https://codeload.github.com/andmerk93/yacut/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244075653,"owners_count":20393980,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","jinja2","python","sqlalchemy"],"created_at":"2024-11-24T01:09:53.392Z","updated_at":"2026-05-21T10:02:10.780Z","avatar_url":"https://github.com/andmerk93.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Сервис YaCut\n\n## Описание проекта\n\nСервис YaCut - это сервис укорачивания ссылок и API к нему\n\nКлючевые возможности сервиса:\n* генерация коротких ссылок и связь их с исходными длинными ссылками\n* переадресация на исходный адрес при обращении к коротким ссылкам\n\nПользовательский интерфейс сервиса — одна страница с формой. Эта форма состоит из двух полей:\n* обязательного для длинной исходной ссылки\n* необязательного для пользовательского варианта короткой ссылки (не должен превышать 16 символов)\n\nЕсли пользователь предложит вариант короткой ссылки, который уже занят, то появляется соответствующее уведомление. Существующая в базе данных ссылка должна остаться неизменной.\n\nЕсли пользователь не заполнит поле со своим вариантом короткой ссылки, то сервис должен сгенерировать её автоматически. Формат для ссылки по умолчанию — шесть случайных символов, в качестве которых можно использовать:\n* большие латинские буквы,\n* маленькие латинские буквы,\n* цифры в диапазоне от 0 до 9.\n\nАвтоматически сгенерированная короткая ссылка добавляется в базу данных, но только если в ней уже нет такого же идентификатора. В противном случае идентификатор генерируется заново.\n\n\n## API для проекта\n\nAPI проекта доступен всем желающим. Сервис обслуживает только два эндпоинта:\n* /api/id/ — POST-запрос на создание новой короткой ссылки;\n* /api/id/\u003cshort_id\u003e/ — GET-запрос на получение оригинальной ссылки по указанному короткому идентификатору.\n\nПримеры запросов к API, варианты ответов и ошибок приведены в спецификации `openapi.yml`\n\n\n## Примеры запросов\n\n**GET** `.../api/id/{short_id}/`\n\n*200*\n```\n{\n  \"url\": \"string\"\n}\n```\n*404*\n```\n{\n  \"message\": \"Указанный id не найден\"\n}\n```\n\n\n**POST** `.../api/id/`\n```\n{\n  \"url\": \"string\",\n  \"custom_id\": \"string\"\n}\n```\n*201*\n```\n{\n  \"url\": \"string\",\n  \"short_link\": \"string\"\n}\n```\n*400*\n```\n{\n  \"message\": \"Отсутствует тело запроса\"\n}\n```\n\n\n## Шаблон наполнения .env файла\n```\nFLASK_APP=yacut\nFLASK_ENV=development\nDATABASE_URI=sqlite:///db.sqlite3\nSECRET_KEY=SECRET\n```\n\n## Требования:\n - Python 3\n - Flask 2\n - SQLAlchemy 1.4\n - Jinja2\n - WTForms\n - и их зависимости (описано в requirements.txt)\n \n## Установка и запуск:\n - клонировать репозиторий на машину, с которой будет будет запускаться сервис \n\n```\ngit clone https://github.com/andmerk93/yacut.git\n```\n\n- На машине должен быть установлен Python актуальной версии (тестировалось на 3.8)\n- развернуть виртуальное окружение python в папке с проектом (yacut)\n```\npython3 -m venv venv\n```\n- активировать виртуальное окружение для linux/unix\n ```\n source ./venv/bin/activate \n ``` \n- для Windows, должно быть разрешено выполнение скриптов Powershell\n ```\n venv\\Scripts\\activate\n ``` \n\n- с запущенным виртуальным окружением нужно выполнить установку требуемых компонентов\n```\npip install -r requirements.txt\n```\n\n- затем, выполнить миграции\n```\nflask db upgrade\n```\n\n- запустить проект\n```\nflask run --port=80\n```\n\nПроект будет доступен по https://localhost/\n\n\n## TODO\n\n- Расположить форму ввода в шаблоне посередине\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandmerk93%2Fyacut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandmerk93%2Fyacut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandmerk93%2Fyacut/lists"}