Nebutra-Sailor/brand.config.example.ts at main · Nebutra/Nebutra-Sailor · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/**
 * Brand Configuration for White-label Deployment
 *
 * Copy this file to `brand.config.ts` and customize for your brand.
 * Run `pnpm brand:apply` to apply changes throughout the codebase.
 *
 * @see WHITELABEL.md for detailed instructions
 */

import type { BrandConfig } from "./scripts/brand-types";

const config: BrandConfig = {
  /**
   * Brand Identity
   */
  brand: {
    name: "MyBrand",
    tagline: "The Open-Source Enterprise SaaS Platform",
    description: "AI-native enterprise platform for multi-tenant systems",

    // Vision statement (for README)
    vision: {
      pillars: [
        { word: "My", meaning: "Your unique value proposition" },
        { word: "Brand", meaning: "Your brand story" },
        { word: "Here", meaning: "Your mission" },
      ],
    },
  },

  /**
   * Company Information
   */
  company: {
    name: "My Company Inc.",
    nameCN: "我的公司", // Chinese name (optional)
    email: "hello@mybrand.com",
    year: 2024, // Founded year for copyright
  },

  /**
   * Domains
   */
  domains: {
    landing: "mybrand.com",
    app: "app.mybrand.com",
    api: "api.mybrand.com",
    studio: "studio.mybrand.com",
    cdn: "cdn.mybrand.com",
  },

  /**
   * Social Links
   */
  social: {
    twitter: "https://twitter.com/mybrand",
    github: "https://github.com/mybrand",
    discord: "https://discord.gg/mybrand",
    linkedin: "https://linkedin.com/company/mybrand",
  },

  /**
   * GitHub Repository (for README badges)
   */
  repo: {
    owner: "mybrand",
    name: "mybrand-platform",
  },

  /**
   * Brand Colors (Tailwind-compatible)
   * Use hex values - will be converted to HSL for CSS variables
   */
  colors: {
    primary: {
      50: "#eef2ff",
      100: "#e0e7ff",
      200: "#c7d2fe",
      300: "#a5b4fc",
      400: "#818cf8",
      500: "#6366f1", // Main primary
      600: "#4f46e5",
      700: "#4338ca",
      800: "#3730a3",
      900: "#312e81",
      950: "#1e1b4b",
    },
    accent: {
      50: "#f0fdfa",
      100: "#ccfbf1",
      200: "#99f6e4",
      300: "#5eead4",
      400: "#2dd4bf",
      500: "#14b8a6", // Main accent
      600: "#0d9488",
      700: "#0f766e",
      800: "#115e59",
      900: "#134e4a",
      950: "#042f2e",
    },
    neutral: {
      0: "#ffffff",
      50: "#fafafa",
      100: "#f4f4f5",
      200: "#e4e4e7",
      300: "#d4d4d8",
      400: "#a1a1aa",
      500: "#71717a",
      600: "#52525b",
      700: "#3f3f46",
      800: "#27272a",
      900: "#18181b",
      950: "#09090b",
    },
  },

  /**
   * Feature Toggles
   * Disable features you don't need - they will be excluded from builds
   */
  features: {
    // Core features (usually keep enabled)
    multiTenant: true,
    ai: true,

    // Optional modules
    web3: false, // Blockchain/crypto features
    ecommerce: false, // Shopify/Shopline integration
    recsys: false, // Recommendation system
    content: true, // Content/feed system

    // Providers
    stripe: true, // Stripe payments
    resend: true, // Resend email

    // i18n
    i18n: true,
    supportedLocales: ["en", "zh-CN"],
  },

  /**
   * Package Naming
   * Change the npm scope for all packages
   */
  packageScope: "@mybrand",

  /**
   * License
   */
  license: {
    type: "FSL-1.1-ALv2",
    commercialExempt: ["My Company Inc."], // Companies exempt from commons clause
  },
};

export default config;