The project is organized using the following structure. It is meant to be fluid and can be updated as necessary.
-
- Files to set up the RTK Query API.
-
- Static resource files for the app (images, SVG, etc...).
-
- Util and Redux functionality that isn't specific to a module.
-
- Components that are used in multiple places throughout the app. Organized into directories based on functionality or by page.
-
- The basic building blocks of the app. This serves as the component library for the app and is largely Material UI library components that need to be modified to fit the app functionality and / or design.
-
- Individual directories corresponding to a slice of the Redux app state. All files for a specific state slice should be grouped in a single directory (e.g. type definitions, state slice, api endpoints, etc...).
-
- Non-reusable page components for the app. Pages can be divided into sub-sections in order to better organize the code.
-
- Files related to the app theme.
All exports should exported from the index.ts file at the top level of each
directory. Two exceptions are the "modules" and "pages" directories. The
"modules" directory should have exports exported from the top level of each
module directory (e.g. modules/session), and the "pages" directory should have
a single export at the top level of each page directory (e.g. pages/home).
Test files should be placed in a "test" directory at the top level of each directory, except for the "modules" and "pages" directories, where they should be placed at the top level of each module or page directory.
Story files should be placed in a "story" directory at the top level of the "elements" and "components" directories.