Folder Structure
Described below the folder structure of template and what is contains.
Understanding the src folder
the src
folder contains all the
assets, pages, constants, helpers redux store etc
files.
-
the
data folder contains all the dummy data for whole template. each file's data is related to every mock api from Fake-backend. E. g. calender.js contains a dummy data which is used in Calendar module/page. -
the
src/Layout/HorizontalLayout/
folder contains all the components files related to Horizontal layout, i.e. Navbar, Header, Footer. -
the
src/Layout/VerticalLayout/
folder contains all the components files related to Vertical layout, i.e. Header, Footer, Sidebar, Sidebar Content. -
src/constants
folder contains the all constants of the template i.e. layout constants. you can add more constant file here. The constants folder added to the template for better performance, let's say if we will require to update value of some variable which is used in many functionalities, then we do not need to update it's value everywhere, we will just update the variable's value located in this folder, and use these constant in relatable functionality. -
src/helpers/
folder contains functional files related to api integration, i.e. firebase, api code, etc. check Internationalization page for more details. -
src/locales
folder contains international translation JSON files, you can add/remove language JSON files as per your need. -
src/pages
contains template's pages, you can create/add/remove you pages here. -
src/store
contains template's global store. check Redux page for more details.
React
├── Admin ├── Documentation --> Documentation ├── Starterkit --> Starter kit of template ├── Admin ├── public ├── src ├── assets ├── fonts --> contains html fonts ├── images --> contains template images └── scss --> contains all scss files ├── CommonData ├── Data --> All dummy data of the template └── languages.js ├── components --> all common components of template ├── constants --> contains whole template's constants ├── helpers --> for authentication firebase and jwt ├── Hooks --> for UserHooks ├── Layout ├── HorizontalLayout --> Horizontal layout's components ├── VerticalLayout --> Vertical layout's components └── NonAuthLayout.js --> Non Auth layout's file ├── locales --> all json files of i18n languages ├── Pages --> contains template pages ├── Routes --> contains template routes ├── store --> Global Redux Store ├── App.js ├── App.test.js ├── config.js --> api key & all secret keys storage read from .env ├── i18n.js --> main file for internationalization ├── index.js ├── serviceWorker.js └── setupTests.js ├── .env --> api key & all secret keys storage └── package.json