https://github.com/vladislavyar/yacut

https://github.com/vladislavyar/yacut

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vladislavyar/yacut
• Owner: VladislavYar
• Created: 2023-09-13T19:41:59.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-28T16:58:47.000Z (11 months ago)
• Last Synced: 2023-12-28T17:58:08.515Z (11 months ago)
• Language: Python
• Size: 72.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# YaCut

## Описание

Проект представляет из себя создания коротких ссылок по средствам редиректа.

В БД хранится соответсвие короткой ссылки сайта проекта к длинной ссылке.

### Имеется API для создания короткой ссылки и её получения

```

/api/id/{short_id}/ - получить ссылку (GET)

/api/id/ - создать короткую ссылку (POST)

{

  "url": "string",

  "custom_id": "string"

}

```

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

Клонировать репозиторий и перейти в него в командной строке:

```

git clone [email protected]:VladislavYar/yacut.git

```

```

cd yacut

```

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

```

python3 -m venv venv

```

* Если у вас Linux/macOS

    ```

    source venv/bin/activate

    ```

* Если у вас windows

    ```

    source venv/scripts/activate

    ```

Установить зависимости из файла requirements.txt:

```

python3 -m pip install --upgrade pip

```

```

pip install -r requirements.txt

```

Создать БД и таблицы в ней:

```

flask db migrate

```

```

flask db upgrade

```

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

```

flask run

```

## Cтек проекта

Python v3.9, Flask, SQLAlchemy