ryanamay/sparkle
1
0
Fork 0
mirror of https://github.com/ryanamay/sparkle.git synced 2024-09-20 03:40:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
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
7 commits 1 branch 0 tags 155 KiB
Python 92.5%
Dockerfile 7.5%
Find a file
Ryana May Que b7906c7c19 add: docker compose
2024-09-06 10:24:10 +08:00
app add: websocket implementation 2024-09-06 09:23:00 +08:00
.env.example add: websocket implementation 2024-09-06 09:23:00 +08:00
.gitignore update: gitignore 2024-09-06 09:22:34 +08:00
docker-compose.yml add: docker compose 2024-09-06 10:24:10 +08:00
Dockerfile add: docker boilerplate, poetry boilerplate 2024-09-06 08:18:10 +08:00
poetry.lock add: websocket implementation 2024-09-06 09:23:00 +08:00
pyproject.toml add: websocket implementation 2024-09-06 09:23:00 +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