https://github.com/cwithmichael/devotionals_api_flask
Api for storing and retrieving daily devotionals built with Swagger and Flask
https://github.com/cwithmichael/devotionals_api_flask
Last synced: 12 days ago
JSON representation
Api for storing and retrieving daily devotionals built with Swagger and Flask
- Host: GitHub
- URL: https://github.com/cwithmichael/devotionals_api_flask
- Owner: cwithmichael
- Created: 2017-12-10T04:33:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T23:51:51.000Z (over 3 years ago)
- Last Synced: 2025-01-03T09:14:38.916Z (over 1 year ago)
- Language: Python
- Size: 34.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Devotionals API
## Overview
This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.
## Requirements
Python 3.5.3+
MongoDB
## Usage
To run the server, make sure you have a MongoDB instance running locally on port 27017 and please execute the following from the root directory:
```
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
python -m swagger_server
```
and open your browser to here:
```
http://localhost:8080/api/v1/ui/
```
Your Swagger definition lives here:
```
http://localhost:8080/api/v1/swagger.json
```
To run the tests
```
tox
```
## Running with Docker
To run the server on a Docker container, please execute the following from the root directory:
```bash
# building the image
docker build -t swagger_server .
docker pull mongo:latest
# starting up a container
docker run --name devotionals_mongo -p 27017:27017 -d mongo
docker run --rm --name devotionals_api --link devotionals_mongo:localhost -p 8080:8080 swagger_server
```