Configuration
Learn how to configure the ShipSaaS template
This document provides a detailed reference for configuring the ShipSaaS template.
Configuration Structure
Configurations are separated into several files within the src/config directory, each responsible for configuring specific aspects of the website.
src/config
website.tsnavbar-config.tsfooter-config.tssidebar-config.tsavatar-config.tssocial-config.ts
Configuration Files
Configuration files are used to define the structure and content of the website.
- Website Configuration - Core settings for the website
- Navbar Configuration - Configure the header navigation menu
- Footer Configuration - Set up links and sections in the website footer
- Sidebar Configuration - Customize the dashboard sidebar navigation
- Avatar Configuration - Configure the user avatar dropdown menu
- Social Configuration - Manage social media links and sharing options
Shared Data Types
Configurations use consistent data types across different menus:
MenuItemConfig
A basic menu item with the following properties:
| Property | Type | Description |
|---|---|---|
title | string | Display text of the menu item |
description | string? | Optional description for dropdown items |
icon | TablerIcon? | Optional Tabler Icons icon component |
href | string? | Target URL link |
external | boolean? | Whether the link opens in a new tab |
authorizeOnly | string[]? | User roles that can see this item |
items | MenuItemConfig[]? | Sub-menu items for dropdown menus |
Best Practices
- Consistently use icons from Tabler Icons to ensure uniformity.
- For menu items visible only to specific roles, use the
authorizeOnlyproperty to restrict visibility. - Use the
Routesobject (defined insrc/lib/routes.ts) to define commonly used links to ensure consistency.
Next Steps
Now that you understand the configuration structure, explore these related topics:
-
Website Configuration - Configure core website settings
-
Navbar Configuration - Configure the header navigation menu
-
Footer Configuration - Configure links in the website footer
-
Sidebar Configuration - Configure the dashboard navigation menu