Skip to content

jcheon/capstone_api_server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 

Repository files navigation

Capstone API server

REST API server that serves capstone.

Docs

Firestore SDK
Uvicorn
FastAPI

Getting started

Requirements

  • Python version >= 3.6
  • pip version >= 9.0
  • uvicorn pip install uvicorn
  • fastapi pip install fastapi

Run the server

Run the server uvicorn main:app --reload

Run server on specific port

uvicorn main:app --reload --port <port number>

Access the API UI

On your browser, go to

http://127.0.0.1:8000/docs

Covered types of places

Place Types docs
gas_station
restaurant
supermarket

the rest of the places will be covered by the 'else' attributes in the Firebase 'cards' collection.

REST endpoints

/latlong/user_id
Returns stores within 500m in radius with best card recommendation for that user.

{
        "store_name": str,
        "card_bank": str,
        "card_name": str,
        "cashback_amount": int,
        "distance": double,
        "img" str, 
},
.
.
.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages