the-great-suspender-restore-urls-service

Service for restoring the broken URLs of the Great Suspender browser (Google Chrome, Firefox) extension

Application

FastAPI (API) + VueJS (UI)

API

Use either Docker or Manual installation. Your API will be available at localhost:8000. Check localhost:8000/docs for the browsable docs. ReDoc is available at localhost:8000/redoc.

Docker

docker-compose up --build

Manual installation

Install the requirements

pip install -r backend/requirements.txt

Run the API

From the backend directory, run the following:

uvicorn app.main:app --reload --workers 1 --host 0.0.0.0 --port 8000

UI

Use either Docker or Manual installation.

Docker

If you use Docker, UI (VueJS) will be available at localhost:8080.

Manual installation

Install

yarn install

Serve

yarn serve