Giter Club home page Giter Club logo

queens-basic-api's Introduction

Drag Queens Collection API

Drag Queens Collection API made using Python 3 and in FastAPI.

Description

Main focus of this project was:

  • create fast and easy REST API based on previously prepared api documentation (OpenApi standard)
  • deploy and provide API for frontend team to play with it

Application was created in two versions:

  • v1.0.0 - basic application, uses in-memory "database" with no authorization nor authentication
  • v2.1.0 - deployed to Deta Space with data storage (NoSQL database), authorization and authentication implemented using JWT

Tech tools

  • Python
  • FastAPI
  • Uvicorn
  • PyJWT
  • bcrypt
  • Deta (deploy)

API Documentation

Original API documentation is located in /docs folder.

Visit deployed application

v1.0.0

API documentation:

https://e4hke1.deta.dev/docs

v2.1.0

API documentation:

https://queensapiv21-1-z9994616.deta.app/docs

Run the application locally

In order to run the project locally, you need to have Python 3 installed.

Each project folder app_v1 and app_v2 should be treated as separate microservice.

  1. Clone repository:
git clone https://github.com/nataliacza/queens-basic-api
  1. Create virtual environment for each microservice app_v1 and app_v2: instruction. Project was build using Poetry.

  2. Install dependencies:

(while being in folder app_v1 or app_v2)
pip install -r requirements.txt

For Poetry:

poetry install
  1. For app_v2 create in main project folder a new file .env, copy data from .env-example file and fill with variables.

  2. Run application on your local machine:

uvicorn main:app --port 8000
  1. Go to application API docs:
http://127.0.0.1:8000/docs

ENJOY!

queens-basic-api's People

Contributors

nataliacza avatar

Watchers

 avatar

Forkers

anfe107

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.