search

karelumair / Quotes-API

1 stars 0 forks source link

Code walkthrough #87

Open pratikGhodke1 opened 1 year ago

pratikGhodke1 commented 1 year ago

Give a code walkthrough of Quotes-API. You should be able to cover-

  1. What tech stack is used.
  2. The application high level architecture and flow. (Good to have flowcharts prepared for this, easier to picture the flow)
  3. What file serves what purpose.
  4. What are the major parts of the codebase.
  5. What could be the possible breakpoint for the application. (URLs, some future changes, creds)

Such code walkthroughs are given when a new person joins your project, and he/she needs to understand what the code is all about. This process is generally called as Knowledge Transfer (KT).

pratikGhodke1 commented 1 year ago

@karelumair Please add a flow chart as discussed here/in wiki and cc me.