Global Configuration in ProtonStack

ProtonStack provides a centralized configuration setup to tailor the behavior of your application. The primary configuration file is located at proton-stack/config/site.ts. Below is an overview of the global configuration options available:

    export type SiteConfig = typeof siteConfig;
 
    export const siteConfig = {
        name: 'Your SaaS app name',
        description: 'Description of your application',
        mainNav: [
            {
                title: 'Home',
                href: '/',
            },
            // ... (other navigation items)
        ],
        links: {
            twitter: '',
            github: '',
            discord: '',
            demo: '',
        },
        paths: {
            auth: {
                signIn: '/sign-in',
                signUp: '/sign-up',
            },
            onboarding: '/onboarding',
            dashboard: '/dashboard',
            settings: {},
            api: {
                auth: {
                    createOrganization: '/api/create-organization',
                },
                subscription: {
                    pricing: '/api/pricing',
                    checkout: '/api/create-checkout-session',
                    plans: '/api/plans',
                    portal: '/api/create-portal-link',
                },
            },
        },
    }

Configuration Options

1. name: The name of your ProtonStack application. description: A short description or tagline for your application.

2. mainNav An array defining the main navigation links of your application. Each item in the array has a title and an href for the link.

3. links External links for social media and other references.

4. paths Various paths used within your application, such as authentication routes, dashboard, and API endpoints.

5. api Configuration related to API endpoints used in your application.

6. settings Placeholder for any application settings (can be customized based on your application's needs).

Usage To customize the global configuration, edit the site.ts file as needed. These configurations will influence various aspects of your ProtonStack application, including navigation, authentication, and API endpoints.

Make sure to restart your development server after making changes for them to take effect.

Explore the full potential of ProtonStack by tailoring the configuration to match the requirements of your project.