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

Frontend folder restructure #805

Merged
merged 25 commits into from
Sep 25, 2024
Merged

Frontend folder restructure #805

merged 25 commits into from
Sep 25, 2024

Conversation

erikguntner
Copy link
Collaborator

@erikguntner erikguntner commented Sep 25, 2024

What changes did you make?

  • Restructured the frontend directory to have this shape:
  • src/ - The source code for the frontend application
    • features/ - Contains the components for the application organized by feature as well as a /ui for shared components
      • feature/ - Inside the features folder are folders containing components for a specific feature along with any other required files.
        • hooks/ - Hooks related to the feature
        • helpers/ - Helper functions related to the feature
        • __tests__ - Tests for components in the feature
    • pages/ - Contains all pages that are rendered by the application. These can be organized by features and contain hooks/, helpers/, and __tests__ subfolders as well.
    • hooks/ - Hooks that are shared across the application
    • redux/ - Contains the redux store, state slices, and helpers for the application
    • services/ - Code related to interfacing with any external APIs
    • theme/ - Any files related to MUI theming and overrides
    • utils/ - All utility functions used throughout the application
  • Moved the /images folder into the public folder
  • Deleted unused components, pages, and related services

Rationale behind the changes?

  • The current files and folder structure needed to be cleaned up as we prepare to onboard new members.

@erikguntner erikguntner merged commit f69f290 into main Sep 25, 2024
0 of 2 checks passed
@erikguntner erikguntner deleted the folder-restructure branch September 25, 2024 23:25
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

Successfully merging this pull request may close these issues.

1 participant