mirror of https://github.com/ryanamay/sparkle.git synced 2024-09-20 04:00:34 +00:00

Sparkle is the powerful API that fuels Twinkle, allowing you to keep track of real-time stock prices and company data with ease. https://sparkle-demo.ryawaa.com/docs

Find a file

Ryana May Que 1dbbf433e1 add: docker boilerplate, poetry boilerplate		2024-09-06 08:18:10 +08:00
app	add: docker boilerplate, poetry boilerplate	2024-09-06 08:18:10 +08:00
.gitignore	add: gitignore	2024-09-06 07:30:50 +08:00
Dockerfile	add: docker boilerplate, poetry boilerplate	2024-09-06 08:18:10 +08:00
poetry.lock	add: docker boilerplate, poetry boilerplate	2024-09-06 08:18:10 +08:00
pyproject.toml	add: docker boilerplate, poetry boilerplate	2024-09-06 08:18:10 +08:00
README.md	add: docker boilerplate, poetry boilerplate	2024-09-06 08:18:10 +08:00

README.md

sparkle

running sparkle via docker (recommended)

docker run -d -p 8000:8000 ryanamay/sparkle

running sparkle directly

sparkle uses poetry to manage dependencies.

to install poetry, run the following command:

via pipx (recommended)

pipx install poetry

via pip

python3 -m venv $VENV_PATH
$VENV_PATH/bin/pip install -U pip setuptools
$VENV_PATH/bin/pip install poetry

running the app via uvicorn

git clone https://github.com/ryanamay/sparkle.git
poetry install
cd app
poetry run uvicorn main:app --host 0.0.0.0 --port 8000