Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Architecture diagrams #47

Open
ceddlyburge opened this issue Oct 14, 2019 · 0 comments
Open

Architecture diagrams #47

ceddlyburge opened this issue Oct 14, 2019 · 0 comments

Comments

@ceddlyburge
Copy link
Owner

ceddlyburge commented Oct 14, 2019

It would be good to add some high level architecture diagrams, to aid development. Probably using mermaid.

To include

  • Concept (Editing google sheets is easy and familiar for most people, so entering fixtures and results is easy, and from this you can get a fully fledged league table type website for teams and players)
  • Types of users (Owner / Administrator, League Editor, League Viewer)
  • Inputs (environment variables and google sheet)
  • High level code flow
  • Maybe high level code structures (although the Model basically describes most of these, so might not be required)

From simon brown's 4s model:

system context diagram

  • scope?
  • who is using it
  • what are they doing
  • how do they do it

container diagram

  • high level tech blocks
  • what are their responsibilities
  • how do they communicate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant