Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rafaelbroseghini/shortie

FastAPI + Redis URL Shortener :globe_with_meridians:
https://github.com/rafaelbroseghini/shortie

Last synced: 16 days ago
JSON representation

FastAPI + Redis URL Shortener :globe_with_meridians:

Awesome Lists containing this project

README

        

# shortie

> A FastAPI + Redis URL Shortener :)

## Prerequisites

`shortie` requires a running instance of Redis version >=6, either locally or hosted.

## How to start

> The `start.sh` script provides a helper flag to run a local `redis-stack-server` container.

```bash
./start.sh --redis-docker
```

If you'd like to point your app to a different redis instance, omit the `--redis-docker` and check [config.py](./app/core/config.py) to see what variables can be overriden.

Navigate to [http://localhost:8000/docs](http://localhost:8000/docs) to see the api docs.