Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anand2312/quill-server
Quill is a realtime drawing and guessing game
https://github.com/anand2312/quill-server
fastapi redis websockets-server
Last synced: about 1 month ago
JSON representation
Quill is a realtime drawing and guessing game
- Host: GitHub
- URL: https://github.com/anand2312/quill-server
- Owner: anand2312
- License: mit
- Created: 2023-11-03T12:43:18.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-17T15:42:59.000Z (11 months ago)
- Last Synced: 2023-12-17T16:39:42.834Z (11 months ago)
- Topics: fastapi, redis, websockets-server
- Language: Python
- Homepage: https://quill-teal-omega.vercel.app
- Size: 472 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# quill-server
Quill is a realtime drawing and guessing game.
Try it out: https://quill-teal-omega.vercel.app \
Frontend Repo: https://github.com/NoelZak03/quill-frontend \
API documentation: https://quill.anand2312.dev/docs
## Setup
After cloning the repository, install dependencies with `poetry`:
```sh
poetry install
```
Install pre-commit hooks:
```sh
poetry run pre-commit install
```
Run the server with:
```sh
poetry run task server
```
Alternativaly, run the server along with the required Postgres and Redis containers with Docker:
```sh
docker compose up
```