Documentation Overview

You may want to define several pages/ directories for what we call a domain-driven file structure (DDD).

// Vite Sitemap Config
// Adds sitemap.xml and robots.txt at build time.

sitemap({
  baseUrl: "https://a11ystart.blue",
  filename: "sitemap.xml",
  defaultChangefreq: "weekly",
  defaultPriority: 0.5,
  robots: { userAgent: "*", disallow: { cloudflare: true } },
  outputDir: "../../public",
}),

1. Update your content files in the /database folder: schemaOrg.ts, faq.ts, glossary.ts, legal.ts, contact.ts, etc. Customize them to reflect your business.

2. Add your Google Analytics ID as PUBLIC_ENV__GOOGLE_ANALYTICS in your .env file.

3. Add your site URL as PUBLIC_ENV__URL in your .env file.

4. Create a newsletter in minutes using Beehiiv— with beehiiv page or your subdomain.

5. Add your RSS feed URL from beehiiv RSS as PUBLIC_ENV__BEEHIIV_RSS_URL in your .env file.

All of the following SEO snippets are already integrated in the boilerplate. Simply reuse them when adding new pages.

// Breadcrumb JSON-LD
// This is already implemented in the boilerplate.
// Include this snippet in +Head.tsx for each page.

export function Head() {
  const data = useData<Data>();
  const PAGE_JSON_LD = generateJsonLd(data);

  return (
    <script
      type="application/ld+json"
      dangerouslySetInnerHTML={{
        __html: JSON.stringify(PAGE_JSON_LD),
      }}
    />
  );
}

Copy these SQL queries from the root server/ folder.

1. Create a Resend account.

2. Navigate to Domains → + Add Domain. Use a subdomain like resend.yourdomain.com.

3. Complete DNS verification, then click Verify DNS Records in Resend.

4. Go to API Keys → + Create API Key, then click Add.

5. Open your .env file and add your RESEND_API_KEY to enable email sending with React Email on the contact/support page.

6. In Supabase → Edge Functions → Secret, store the API key RESEND_API_KEY.

7. In Supabase → Authentication → Email settings, enable Custom SMTP and configure the following:

   • Sender details

   • SMTP Provider Settings

• Send emails from a subdomain (e.g., resend.domain.com)

• Add an SPF record for the subdomain

• Add a DKIM record for the subdomain

• Add a DMARC record for the subdomain

• Include an unsubscribe link at the bottom of each email

• Personalize emails using the recipient’s name

• Avoid spam-trigger words like "free" or "earn money"

• Avoid strange fonts, inconsistent layout, or excessive punctuation

• Avoid linking to untrusted or suspicious websites

1. Create a Stripe account and activate payments.

2. In [Settings] → [Public Details], add your website URL.

3. In [Settings] → [Branding], add your logo and colors.

4. Enable payment and refund emails in [Customer Emails].

5. Optionally enable the customer portal in [Customer Portal].

6. Under [Rules], enable 3DS and block on CVC failure.

7. Turn ON Test Mode.

8. Create a product and copy the price ID into StripeBtn.tsx.

9. Add your API key to .env.local as STRIPE_SECRET_KEY.

10. Add PUBLIC_ENV__CUSTOMER_PORTAL_LINK to your .env file to allow users to manage their subscription and Stripe account via a dedicated portal.

11. Use Stripe CLI: stripe listen --forward-to localhost:3000/api/webhook/stripe

12. If using coupons, define them in server/controllers/stripe.ts

13. In Supabase, enable Vault and the Stripe Wrapper extension.

14. Define a new schema and name it : Stripe in your wrapper.

15. In your Supabase edge function, include STRIPE_SECRET_KEY and add the secret.

16. Deploy a new edge functions to handle Stripe webhook, past handleStripeWebhook.ts and deploy it.

17. In Supabase editor run stripe.sql

<!-- Template for Magic Link Email -->
<!-- Use this in Supabase Auth Email Templates section -->
<!-- Customize as needed for your business logic -->

<h2>Login with Magic Link</h2>

<p>Click the link below to log in:</p>
<p><a href="{{ .SiteURL }}/welcome/confirm?token_hash={{ .TokenHash }}&type=email">Log In</a></p>

1. In your Supabase dashboard, navigate to Authentication → URL Configuration. Add the following:
   https://your-domain.com to Site URL and:
   https://your-domain.com/** and http://localhost:3000/** to Redirect URLs.

2. Set up a custom SMTP server to send branded emails.

3. Configure email rate limits within your SMTP provider to avoid spam or abuse issues.

4. Consider using Resend for reliable and scalable transactional emails.

5. Go to Authentication → Attack Protection, enable Enable Captcha protection and choose Turnstile by Cloudflare.

1. Create a Crisp account .

2. Go to the Crisp Cloudflare Integration page and click Install the App.

3. Enter your Crisp Website ID when prompted.

4. Once installed, the chat widget is automatically embedded across your website, with no code required.

# Sentry configuration
SENTRY_AUTH_TOKEN=
SENTRY_ORG=
SENTRY_PROJECT=
PUBLIC_ENV__SENTRY_DSN=

1. Fill in the required Sentry environment variables in your .env file.

2. The function sentryBrowserConfig() is already invoked in sentry.browser.config.ts to initialize Sentry on the frontend.

3. A global window.addEventListener("error") logs unhandled exceptions to the console.

4. A custom error page is defined at /pages/_error/+Page.js. It’s automatically shown when an error occurs or when throw render(abortStatusCode) is called.

5. Developer tooling is pre-configured with tsconfig.json, eslint.config.js, and .prettierrc already set up for a clean DX.

Even in TypeScript, runtime validation matters. Use Zod to protect your API routes from invalid payloads.

Learn more about the metadata file convention.