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

Wiki page about architectural decisions, folder structure #16

Open
leonardonegrao opened this issue Sep 11, 2021 · 0 comments
Open

Wiki page about architectural decisions, folder structure #16

leonardonegrao opened this issue Sep 11, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@leonardonegrao
Copy link
Owner

leonardonegrao commented Sep 11, 2021

Explain the decisions and inspirations behind the structure of the project:

  • The basics: use of src folder and initial folders
    • Absolute paths
    • The theme folder
    • The pages folder
    • The models folder
    • The infra folder
    • The components folder
  • Important components
    • Why Link and Image components encapsulating the one's from Next
      • Application agnostic when using these components (don't care about Next's implementation)
      • Common configuration and styling (mostly for the Image)
  • The wrappers and screens: why this way?
    • Bootcamp Front-end Avançado
    • Separation of concerns between application and framework (less use of _app.tsx for example)
  • The component recipe: how components are structured
    • What is a component for this application: A piece of code that is independent of it's siblings, that if a repair is needed, the developer is able to focus almost atomically, only on that node of the Component Tree and it's children. While this advice was not necessarily followed, it was kept in mind.
    • Inner components folder
      • The Angular way
      • Less entropy
      • Layers
    • Building Resilient Frontend Architecture by Monica Lent (GOTO 2019)
    • How that turned into Prop Drilling, but why Prop Drilling was part of the architecture (State Management)
@leonardonegrao leonardonegrao added the documentation Improvements or additions to documentation label Sep 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant