Dashboards
Applications
UI Elements
Pages
External Link
Menu Levels
Docs
Settings

Go premium to get all the cool features!

View Plans
AboutDocsPurchase
  • Welcome
  • Introduction
  • FAQ
  • Changelog
  • Getting Started
  • Installation
  • File Structure
  • Routing and Menu
  • Multi Language
  • Theme
  • Settings
  • Theme Provider
  • Styling

File Structure

  1. Home
  2. /
  3. Docs
  4. /
  5. Getting Started
  6. /
  7. File Structure

Gogo MUI Admin - Next.js Version

Project structure and short explanations:

1+-- .husky                                // Husky auto-generated files
2+-- public                                // Images, favicons and initial loader
3    | 
4    +-- favicon                           // Favicons of the project
5    +-- images                            // Images of the project
6    |-- initial-loader.css                // Loader styling of the project
7    |-- initial-loader.js                 // Loader script of the project
8+-- src                                   // Source code of the project
9    | 
10    +-- app                               // Pages and routes
11    +-- components                        // Components used project wide such as Header, Logo, Menu and so on
12    +-- hooks                             // Basic hooks for menu, charts and screens
13    +-- i18n                              // Multi-language files and translations
14    +-- icons                             // Custom Nexture icons
15    +-- lib                               // Utilities that are used throughout the project
16    +-- style                             // All the CSS files
17    +-- theme                             // Theme provider and MUI theme overrides
18    |-- config.ts                         // The main theme configuration
19    |-- constants.ts                      // Variable definitions that are used in the theme
20    |-- menu-items.tsx                    // Menu data source
21    |-- types.ts                          // Types used globally in the project 
22|-- .env                                  // Variables for different environments
23|-- .eslintignore                         // Files that will be excluded from Eslint
24|-- .gitignore                            // Files that will be excluded from Git
25|-- .huskyrc                              // Husky configuration
26|-- .lintstagedrc                         // Lint configuration for staged commits
27|-- .nvmrc                                // Node version
28|-- .prettierignore                       // Files that will be excluded from Prettier
29|-- .prettierrc                           // Prettier configuration
30|-- README.md                             // Details about the project
31|-- middleware.ts                         // Next.js customizations
32|-- next.config.mjs                       // Next.js configuration
33|-- package.json                          // List of packages that are used in the project
34|-- package.lock.json                     // List of package versions
35|-- postcss.config.mjs                    // PostCSS configuration
36|-- tailwind.config.ts                    // Tailwind configuration
37|-- tsconfig.json                         // Typescript configuration