Skip to content
ShipSaaSShipSaaS Docs

Configuration

This document provides a detailed reference for configuring the ShipSaaS template.

Configuration Structure

Section titled “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.ts
  • navbar-config.ts
  • footer-config.ts
  • sidebar-config.ts
  • avatar-config.ts
  • social-config.ts

Configuration Files

Section titled “Configuration Files”

Configuration files are used to define the structure and content of the website.

Shared Data Types

Section titled “Shared Data Types”

Configurations use consistent data types across different menus:

Section titled “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

Section titled “Best Practices”
  1. Consistently use icons from Tabler Icons to ensure uniformity.
  2. For menu items visible only to specific roles, use the authorizeOnly property to restrict visibility.
  3. Use the Routes object (defined in src/lib/routes.ts) to define commonly used links to ensure consistency.

Next Steps

Section titled “Next Steps”

Now that you understand the configuration structure, explore these related topics: