Folder Structure
- Docs
- Folder Structure
Use below velzon structure for modify and better understanding of Velzon.
1. Velzon Assets Folders
Folder | Path | Description |
---|---|---|
Assets |
src/assets |
Here are all the asset files, including images, videos, fonts, and SCSS files. |
Fonts |
src/assets/scss/fonts |
Font style files are here. |
Images |
src/assets/images |
This folder contains all the images used in the admin section. |
Scss |
src/assets/scss |
Here, you can find all the SCSS files. |
theme.scss |
src/assets/scss/themes.scss |
The primary SCSS file is "themes.scss," which serves as the entry point connecting all other SCSS files and is imported into either "app.js" or "app.ts." |
Components |
src/assets/scss/components |
Here are all the SCSS files for the components. |
Config |
src/assets/scss/config |
Here are all the configuration files, including variables, Bootstrap, and custom configurations. |
custom.scss |
src/assets/scss/config/default/custom.scss |
Customers have the option to use the "custom.scss" file for adding extra CSS. |
Pages |
src/assets/scss/pages |
All the pages related scss files are here |
Plugins |
src/assets/scss/plugins |
Here, you can find all the SCSS files related to plugins, such as chats, tables, Swiper, and others. |
RTL |
src/assets/scss/rtl |
The SCSS files related to RTL (Right-to-Left) support. |
Structure |
src/assets/scss/structure |
All the SCSS files related to the admin structure, including layouts, footer, and header. |
2. Default Folders
Folder | Path | Description |
---|---|---|
Common |
src/common/data |
Here, you can find all the JSON data related to the pages. |
Components |
src/components/common |
Here are the common components used for both layout and admin. |
Routes |
src/Routes/ |
You can find descriptions for all the route paths in either "allRoutes.js" or "allRoutes.ts." |
Auth |
src/slices/auth |
The authentication pages, along with their related thunk and reducer files, can be found in the "src/pages/Authentication" folder. |
Locals |
src/locales |
Multiple languages supported files in the admin interface. |
i18 |
src/i18n.js |
This file is utilized for implementing support for multiple languages. |
Slice |
src/slices |
All the reducers and thunk files for pages located here |
Layouts |
src/Layouts |
Layout related files are here like verticle, horizontal and two column. |
Pages |
src/pages |
Here, you will find all of the admin pages along with their respective functionalities. |
.env |
.env |
Env files are used to store sensitive credentials such as Firebase keys. |
Package.json |
package.json |
You can find packages and dependencies used in admin here. |
- Master-Javascript (>= v4.0.0)
-
- assets
- common
- Components
- helpers
- Layouts
- locales
- pages
- Routes
- slices
- App.css
- App.js
- App.test.js
- config.js
- i18n.js
- index.js
- reportWebVitals.js
- setupTests.js
- Master-Typescript (>= v4.0.0)
-
- assets
- common
- Components
- helpers
- Layouts
- locales
- pages
- Routes
- slices
- App.css
- App.tsx
- App.test.ts
- config.ts
- i18n.ts
- index.tsx
- reportWebVitals.ts
- setupTests.ts