Giter Club home page Giter Club logo

apip-project-shrekit's Introduction

APiP-Project

Shrek IT

Docker Image and Deploy Lint and test

Advanced Programming with Python - Project

ShrekIT! Great small web app for adding Shrek Ears to your photos ๐Ÿš€

Dependencies

All Python dependencies are in the requirements.txt file. And outside of that we use Deta as our cloud server for the app.

Prerequisites

Before starting work on the project you must install all needed dependencies:

    pip install -r requirements.txt

Moreover probably will need to setup .env file in the project root with PROJECT_KEY for Deta to work accordingly. For that contact @lswarss

How to

How to run the app for the first time

uvicorn main:app 

How to run the app with hot reload

uvicorn app.main:app --reload

Full endpoints documentation with Swagger

For full documentation go the https://localhost:8000/docs

How to build and run docker image

docker build -t apip-image .
docker run -d --name apip-container -p 80:80 apip-image 

Swagger UI Documentation

You can access swagger documentation of the application under address 0.0.0.0/docs

How to Deploy

Deployment of the app is made with Docker Registry and DigitialOcean App Platform. And to trigger deployment you must:

  • Add new release tag on Github with pattern: v*
  • Or merge pull request to main branch

Those actions will trigger deployment pipeline and create new build in registry + deploy it to DigitialOcean.

apip-project-shrekit's People

Contributors

psztefko avatar verticalheretic avatar

Watchers

 avatar

apip-project-shrekit's Issues

Continuous Delivery Github Actions Pipeline

DOD (Definition of Done):

  • Github Action yml added
  • Configured project building
  • Configured deployment process with Docker Registry
  • Some kind of push notification for Discord/Slack or something about pipeline success or failure

Continues Integration GitHub Action configured

DOD (Definition of Done):

  • Github Action yml added
  • Configured project building
  • Configured project unit testing
  • Some kind of push notification for Discord/Slack or something about pipeline success or failure

Additionally:

  • Code coverage report

Images REST API and Swagger

DOD (Definition of Done)

  • Image upload endpoint
  • Image getting endpoint
  • Image processing status endpoint
  • Swagger for the endpoints as form of documentation

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.