Code Monkey home page Code Monkey logo

soora-sr-proto's Introduction

Protofiles for Soora Spaced Repetition Test

This repository defines protofiles the following microservices:

  • auth
  • flashcard

Microservice Flow

Microservice Flow

Repositories

Instructions

1. Clone API Gateway

git clone https://github.com/abulhuman/soora-sr-api-gateway.git

2. Clone Auth Microservice

git clone https://github.com/abulhuman/soora-sr-auth-svc.git

3. Clone Flashcard Microservice

git clone https://github.com/abulhuman/soora-sr-flashcard-svc.git

4. Follow the instructions in each repository's README file

โ„น๏ธ I have used a separate database for each microservice since that is the best approach to acheive loose coupling. I used mongoDB Atlas for development speed but using a docker container for the db is the best approach for production environments.
My implementation of the Optional Feature # 3.1 allows me to use the same code to acheive Optional Feature # 3.2 as well since I always get visible flashcards that have nextReviewDate that is due or overdue.

5. Test the API Gateway

Import the postman collection json file into postman to see all the required API endpoints with their variants. I have provided you with it in this repository to test the api gateway. ๐Ÿ”—๐Ÿ‘‰ POSTMAN Collection File. You can then right click on the imported postman collection then click on View Documentation to see each example.

Usage:

// package.json
...
"dependencies": {
  ...
  "soora-sr-proto": "git+https://github.com/abulhuman/soora-sr-proto.git",
  ...
}
...
// index.ts
// eg: gRPC config object for auth microservice
{
    // ...
    protoPath: 'node_modules/soora-sr-proto/proto/auth.proto',
    // ...
}

Author:

soora-sr-proto's People

Contributors

abulhuman avatar

Watchers

 avatar

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.