mediahub-fe/pages/docs/starter-kit.mdx

98 lines
2.0 KiB
Plaintext
Raw Permalink Normal View History

2024-11-26 03:09:48 +00:00
# Starter Kit
Starter-kit is a minimal template from where you can start your project quickly instead of removing stuff that isn't needed. Below are quick notes on the starter-kit:
- No Auth
- No Dashboard
- No Apps
- No Pages
- No Elements
### Folder Structure
Learn about the folder structure of the Starter Kit and its contents.
```
|
├─ app
│ ├─ (dashboard)
│ │ |-layout.jsx
│ │ |-main-layout.jsx
│ │ |-page.jsx
│ │
│ ├─ api
│ ├─ assets
│ |- favicon.ico
│ |- layout.jsx
│ |- not-found.js
├─ components
│ ├─ landing-page
│ ├─ partials
│ ├─ svg
│ ├─ ui
| |-blank.jsx
│ |-dashboard-select.jsx
│ |-dashboard-dropdown.jsx
│ |-date-picker-with-range.jsx
│ |-delete-confirmation-dialog.jsx
│ |-error-block.jsx
│ |-header-search.jsx
│ |-layout-order.jsx
│ |-ripple.jsx
|
├─ config
├─ hooks
├─ lib
│ ├─ docs
│ |-appex-chat-options.jsx
│ |-auth.js
│ |-utils.js
├─ provider
├─ public
├─ store
|- .env.local
|- .gitignore
|- jsconfig.json
|- middleware.js
|- next.env.d.ts
|- next.config.js
|- package-lock.json
|- package.json
|- README.md
|- postcss.config.js
|- tailwind.config.js
|- theme.config.js
|- yarn.lock
```
### Theme Configuration
Configuring themes in Dashcode is incredibly simple. The primary configuration file is type.ts. Inside the type.ts file, you can set up your theme, layout, sidebar type, sidebar color, and more. Refer to the code snippet below for all available options.
```ts filename="hooks/use-config.ts"
export const Config = {
"collapsed": false,
"theme": "violet",
"skin": "default",
"layout": "vertical",
"sidebar": "draggable",
"menuHidden": false,
"showSearchBar": true,
"topHeader": "default",
"contentWidth": "wide",
"navbar": "sticky",
"footer": "sticky",
"isRtl": false,
"showSwitcher": true,
"subMenu": false,
"hasSubMenu": false,
"sidebarTheme": "redwood",
"headerTheme": "light",
"radius": 0.5
};
```