https://github.com/szykol/quizmous-api

Api for quizmous web app
https://github.com/szykol/quizmous-api

Last synced: 2 months ago
JSON representation

Api for quizmous web app

• Host: GitHub
• URL: https://github.com/szykol/quizmous-api
• Owner: szykol
• License: mit
• Created: 2020-03-27T20:21:59.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-08-06T05:26:04.000Z (almost 3 years ago)
• Last Synced: 2025-04-15T02:07:24.316Z (2 months ago)
• Language: Python
• Size: 5.66 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# quizmous-api

Api for quizmous web app

## Prerequisties

You need to have docker to build the app

General code documentation can be found [here](https://szykol.github.io/quizmous-api/).

API docs generated using swagger can be found [here](https://szykol.github.io/quizmous-api/api.html).

## Quick start

For unix users:

```

./setup_api.sh --rebuild --deamon

curl localhost:8000 # to see if it works

./setup_api.sh # launches the docker container with bash entrypoint

./setup_api.sh --test # launches tests

```

## Endpoints

```

/ [GET]

```

returns

```

{"name": "quizmous", "version": "0.0.1"}

```

### This project uses github actions to perform builds and running tests on every commit