Giter VIP home page Giter VIP logo

6156-cc98bbs-microservice-1's Introduction

6156-microservice-1

Simple starter template from Professor's template project.

Directory Structure

Folders and files

  • data/: json files containing data

  • resources/: supportive python scripts

    • entityxxx: the entity in the microservice structure
      • xxx_data_service: a class that understands how to connect to an external database and get data in and out of the database. (Eventually it will connect to database, but for now it reads data from ./data/xxx.json.)
      • xxx_resources: an interface to data_service.
      • xxx_models: the data objects that can go back and forth in OpenAPI. (also define attributes here)
  • static/: html files

  • tts/: test cases

    • It contains test cases for every xxx_data_service and xxx_resource in ./resources/.
  • main.py is the python application launched to start the web service.

    • also implement paths here.
  • The .gitignore file is the default for python from GitHub and prevents pushing the virtual environment and python-related files into the repo.

Python Virtual Environment

  • Using a python virtual environment is a best practice.

  • This projects virtual environment is in venv.

Links

Final Project Functionalities

  • Enhance Microservices Implementation:
    • Core operations (GET, PUT, POST, DELETE) from each microservice.
    • Show results changing with provided query parameters.
  • Events, Notifications, Pub/Sub:
    • Take a screenshot of your code publishing events to any queue systems (SNS, Google Pub/Sub).
    • Make a request to a microservice and Lambda function handling the published events.
  • Composition/Aggregators:
    • Demonstrate a synchronous call that prints a log when getting a response from each microservice.
    • Demonstrate an asynchronous call that prints a log when getting a response from each microservice. (repeat it 10 times, and it should microservices should be done in a different order at least once).
  • API Gateway:
    • Demonstrate your API Gateway Implementation, which shows both authorized and unauthorized cases.
  • Single Sign-On (SSO):
    • Demonstrate SSO login and make an authorized request using the given token.
  • External API:
    • Explain what External API you are using and what this is for in your application, and demonstrate the functionality.
  • Middleware
    • Introduce one Middleware functionality in your application and explain what it does.
  • CI/CD
    • Demonstrate your CI/CD pipelines running on specific events.
  • Infrastructure As Code
    • Deploy and shut down any simple infrastructure in your project.
  • GraphQL
    • Implement a simple example of GraphQL using one of the functionalities of your application.

6156-cc98bbs-microservice-1's People

Contributors

zhongheng-cheng avatar

Watchers

 avatar

6156-cc98bbs-microservice-1's Issues

Middleware

  • Add framework for middleware
  • Add reasonable function for middleware

Github Actions

  • Add a Github Actions for microservice 1
  • Target function: pull the code, start the microservice, check if it is working (using a curl command), and then kill the process and exit. The success of the job (like a check if the build is fine) will depend on the HTTP response for the curl command. (ED #352)

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.