CivicTechJobs icon indicating copy to clipboard operation
CivicTechJobs copied to clipboard

Create uml diagram of frontend/backend

Open Aveline-art opened this issue 2 years ago • 5 comments

Overview

As a developer we need to provide diagrams that helps the team make sense of our growing project. For this issue we will make a uml diagram of our front and backend design.

Action Items

  • [ ] Create a diagram using github's mermaid syntax
  • [ ] Add this diagram to our mkdocs assets
  • [ ] Have a link to it on our front/backend architecture wiki and somewhere in our README.md

Resources/Instructions

Resources

README.md Include diagrams in your Markdown files with Mermaid

Note: Since mermaid rendering is native to GitHub, feel free to use a comment in this issue as a space to R&D before drafting and committing the files.

Aveline-art avatar Apr 29 '22 22:04 Aveline-art