Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 2.33 KB

README.md

File metadata and controls

81 lines (51 loc) · 2.33 KB

pz-kb-server 🦓🩷

Flask's Server Backend between (KillBill, Bigcommerce, Braintree) for the v2 of the Pink Zebra project

Prerequisites

  1. You need to have Docker installed on your machine.
  2. Then get the .env, install Warp VPN and configure it (ask the developer team for this step)

📦 Docker's Commands

Build the image

docker build -t pz-kb-server .

Create container

docker run --name pz-kb-server-container -d -p 5000:5000 pz-kb-server

Run container

docker run pz-kb-server-container

Shell inside container

docker exec -it pz-kb-server-container /bin/sh

Stop container

docker stop pz-kb-server

Remove container

docker rmi pz-kb-server-container

↪️ Commands inside container

run server

flask run

run tests




Note for developers 📝


    

  • 

    📍 When add, move or remove any route file/folder please restart the server to watch the changes ..
    

    • 

  • 

    📖 Swagger UI is located at .../apidocs/ and 🧾 Swagger spec can be fount at .../apispec.json
    

    • 

  • 

    Please follow are rules ⚖️ to contribute in CONTRIBUTING.md
    

    • 



⚙️ Built with :


    

  • Flask : Is a lightweight WSGI web application framework in Python
    • 

  • flasgger : Is a simple Flask blueprint for adding Swagger UI to your Flask application; based on swagger.io
    • 

  • KillBill : Is an open-source billing and payment platform that automates complex billing processes.
    • 

  • BigCommerce : Is a NASDAQ-listed ecommerce platform that provides software as a service (SaaS) solutions to retailers.
    • 

  • Braintree : Is a full-stack payment platform from PayPal that makes it easy to accept payments in your app or website.
    •