File tree Expand file tree Collapse file tree 1 file changed +6
-0
lines changed
Expand file tree Collapse file tree 1 file changed +6
-0
lines changed Original file line number Diff line number Diff line change @@ -29,6 +29,7 @@ The codebase can be better visualized as below:
2929 - [ Solution] ( #solution )
3030- [ Assumptions] ( #assumptions )
3131- [ ToDo] ( #todo )
32+ - [ Documentation] ( #documentation )
3233 - [ App Code] ( #app-code )
3334 - [ IAC] ( #iac )
3435 - [ CI/CD] ( #cicd )
@@ -364,10 +365,15 @@ The solution can be visualized with the help of below request flow diagram:
364365
365366# Assumptions
366367- The API needs to be publicly accessible.
368+ - The intendant audience has decent understanding of Azure Cloud, Github Actions, Terraform, Docker.
369+ - They are using Macbook or similar development environment.
367370
368371# ToDo
369372
370373Below is the list of the things we must do to make the implementation production ready.
374+ # # Documentation
375+ - Add Links to the official documentations.
376+
371377# # App Code
372378- Migrate from Pip to modern package managers like ` Pipenv` or ` Poetry` for better dependency management.
373379- Implement Unit Test and E2E test appropriately to adhere ` Test Pyramid strategy` thus maturing testing strategy.
You can’t perform that action at this time.
0 commit comments