Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alenrajsp/sport-activities-features-api
https://github.com/alenrajsp/sport-activities-features-api
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alenrajsp/sport-activities-features-api
- Owner: alenrajsp
- License: mit
- Created: 2022-01-13T00:39:28.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T21:26:54.000Z (almost 2 years ago)
- Last Synced: 2023-03-23T08:27:58.746Z (over 1 year ago)
- Language: Python
- Size: 210 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sport-activities-features API
Sport-activities-features API is a Python library for using
[sport-activities-features](https://github.com/firefly-cpp/sport-activities-features) as an FastAPI based web API.
### Note
Please view [Swagger docs](localhost:8000/docs) to see how to use this API.
## Installation
1. Download project
2. Install dependencies with Poetry
```bash
poetry install
```
3. Navigate to project folder and run server in terminal.
```bash
uvicorn main:app --reload
```
## How to use (locally)
1. Run server (**main.py**)
2. Navigate to [Swagger docs](localhost:8000/docs) to see how to use.
## How to use (Docker)
1. Use the official image from DockerHub repository
[alenrajsp/sport-activities-features-api](https://hub.docker.com/r/alenrajsp/sport-activities-features-api)
2. Run from terminal with
`docker run -p :80 alenrajsp/sport-activities-features-api`.
The **\** variable is the port from which you want to access the container.
| Folder / file | Description |
| ------------- | ----------------------------------------------------------------------------------------- |
| /helpers | Folder for helper classes (JSON transformations, folder navigation, temp file management) |
| /models | Request / Response FastAPI models |
| /routers | Individual routes of FastAPI and functionalities |
| /temp | Temporary files that, get generated when recieving requests and deleted afterwards |
## License
[MIT](https://choosealicense.com/licenses/mit/)