search

CovidWorld / server

MIT License
17 stars 9 forks source link

Documentation is non existent #1

Open zakisaadeh opened 4 years ago

zakisaadeh commented 4 years ago

Hi,

This is a great initiative. However, if it is to be used successfully, we need to be able to understand 1. How the services work with each other (maybe a high level description or diagram).

  1. How to deploy this solution? What depends on what? What's needed for deployments to work?
  2. Any other guidance that would help us avoid common issues you face while working on this and deploying.

Thanks!

zakisaadeh commented 4 years ago

Please include what kind of configuration and 3rd party services we need to setup. What environment variables to set?

Daziko commented 4 years ago

Please include what kind of configuration and 3rd party services we need to setup. What environment variables to set?

Hi, I will include sample config file with description of desired variables soon.

Daziko commented 4 years ago
  1. How the services work with each other (maybe a high level description or diagram). Basically there are 3 main parts (functions).
    • API function: Contains all endpoints necessary for communications with application clients.
    • Admin function: Contains secured endpoint which can be consumed by some front-end clients (SPA, Webs, etc.) or directly by your government APIs.
    • Worker function: Contains scheduled jobs whose can send notification to the clients or count some statistics. You can easily implement other jobs which will fit your needs.
  2. How to deploy this solution? What's needed for deployments to work?

What depends on what?

  • It is classic onion model of DDD. Azure Functions are just presentation layer you can easily swap them for a Web app, Service fabric, Kubernetes ... The only role of this presentation layer is to fire mediator commands/queries. I will create some basic diagrams soon.
zakisaadeh commented 4 years ago

@Daziko Thanks for all the above. Any chance you could create the docs sooner rather than later? We're in a dire need to deploy this for our country and it would be great if you can help with additional docs to get us up and running pretty quickly. I assume that other devs looking at this may be in the same boat.

ojizero commented 4 years ago

@Daziko there's also the mapping between the service endpoints requested by the apps and how they map to the Azure Functions, is it possible to also add the API Gateway info (I'm trying to piece the info out between what the apps and the Azure Functions but giving the info could make life a ton easier).

Thanks in advance.