Folder Structure

A simple, intuitive folder structure ensures easy navigation without any hassle.

Under themantis-material-react/ In the directory, you will find the following folder structure.

mantis-react-ts
..
β”œβ”€β”€ src
β”‚   β”œβ”€β”€ _api               -> Mock JSON data to be used for working apps
β”‚   β”œβ”€β”€ assets
β”‚   β”‚   β”œβ”€β”€ images
β”‚   β”‚   β”œβ”€β”€ third-party    -> Third-party styles
β”‚   β”œβ”€β”€ components         -> Common components used across a theme
β”‚   β”‚   β”œβ”€β”€ @extended      -> Extended components of MUI
β”‚   β”‚   β”œβ”€β”€ cards          -> Cards used at different locations
β”‚   β”‚   β”œβ”€β”€ logo
β”‚   β”‚   β”œβ”€β”€ third-party
β”‚   β”‚   β”œβ”€β”€ ...
β”‚   β”œβ”€β”€ contexts           -> State context for Login management & config
β”‚   β”œβ”€β”€ data               -> Static data
β”‚   β”œβ”€β”€ hooks              -> Custom hooks
β”‚   β”œβ”€β”€ layout
β”‚   β”‚   β”œβ”€β”€ Auth           -> Layout for login showcase
β”‚   β”‚   β”œβ”€β”€ Component      -> Layout for components showcase
β”‚   β”‚   β”œβ”€β”€ Dashboard      -> Layout for dashboard
β”‚   β”‚   β”œβ”€β”€ Pages          -> Blank pages
β”‚   β”‚   β”œβ”€β”€ Simple         -> Layout for landing and contact showcase
β”‚   β”œβ”€β”€ menu-items         -> Menu items
β”‚   β”œβ”€β”€ metrics            -> metrics items
β”‚   β”œβ”€β”€ pages              -> View files for all pages
β”‚   β”‚   β”œβ”€β”€ apps
β”‚   β”‚   β”œβ”€β”€ auth
β”‚   β”‚   β”œβ”€β”€ ...
β”‚   β”œβ”€β”€ routes             -> Different routes based on layouts
β”‚   β”œβ”€β”€ sections           -> This contains different sections used only for pages
β”‚   β”œβ”€β”€ themes             -> Contains application style and theme
β”‚   β”‚   β”œβ”€β”€ overrides      -> MUI overrides for each component
β”‚   β”‚   β”œβ”€β”€ theme          -> Different theme preset
β”‚   β”‚   β”œβ”€β”€ ...            -> Other theme-related setups
β”‚   β”œβ”€β”€ type               -> common types for Typescript
β”‚   β”œβ”€β”€ utils
β”‚   β”‚   β”œβ”€β”€ locales        -> Different locale JSON files
β”‚   β”‚   β”œβ”€β”€ route-guard    -> Auth guard to prevent unexpected navigations
β”‚   β”‚   β”œβ”€β”€ ...            -> Other utils function
β”‚   β”œβ”€β”€ App.tsx
β”‚   β”œβ”€β”€ config.ts          -> Different theme config
β”‚   β”œβ”€β”€ index.tsx
β”œβ”€β”€ .env                   -> Store configuration settings and environment variables
β”œβ”€β”€ eslint.config.mjs      -> To configure ESLint rules
β”œβ”€β”€ .prettierrc            -> To Code formatting style rules
β”œβ”€β”€ tsconfig.json
β”œβ”€β”€ package-lock.json      -> File generated by npm
β”œβ”€β”€ package.json           -> Contains metadata (name, version, dependencies, scripts, and other)
β”œβ”€β”€ README.md
β”œβ”€β”€ yarn.lock              -> File generated by yarn

Last updated