mirror of
https://github.com/arsvendg/Stirling-PDF.git
synced 2026-07-16 03:20:46 +02:00
James BruntonandGitHub
8674765528
# Description of Changes Previously, `VITE_*` environment variables were scattered across the codebase with hardcoded fallback values inline (e.g. `import.meta.env.VITE_STRIPE_KEY || 'pk_live_...'`). This made it unclear which variables were required, what they were for, and caused real keys to be silently used in builds where they hadn't been explicitly configured. ## What's changed I've added `frontend/.env.example` and `frontend/.env.desktop.example`, which declare every `VITE_*` variable the app uses, with comments explaining each one and sensible defaults where applicable. These are the source of truth for what's required. I've added a setup script which runs before `npm run dev`, `build`, `tauri-dev`, and all `tauri-build*` commands. It: - Creates your local `.env` / `.env.desktop` from the example files on first run, so you don't need to do anything manually - Errors if you're missing keys that the example defines (e.g. after pulling changes that added a new variable). These can either be manually-set env vars, or in your `.env` file (env vars take precedence over `.env` file vars when running) - Warns if you have `VITE_*` variables set in your environment that aren't listed in any example file I've removed all `|| 'hardcoded-value'` defaults from source files because they are not necessary in this system, as all variables must be explicitly set (they can be set to `VITE_ENV_VAR=`, just as long as the variable actually exists). I think this system will make it really obvious exactly what you need to set and what's actually running in the code. I've added a test that checks that every `import.meta.env.VITE_*` reference found in source is present in at least one example file, so new variables can't be added without being documented. ## For contributors New contributors shouldn't need to do anything - `npm run dev` will create your `.env` automatically. If you already have a `.env` file in the `frontend/` folder, you may well need to update it to make the system happy. Here's an example output from running `npm run dev` with an old `.env` file: ``` $ npm run dev > [email protected] dev > npm run prep && vite > [email protected] prep > tsx scripts/setup-env.ts && npm run generate-icons setup-env: see frontend/README.md#environment-variables for documentation setup-env: .env is missing keys from config/.env.example: VITE_GOOGLE_DRIVE_CLIENT_ID VITE_GOOGLE_DRIVE_API_KEY VITE_GOOGLE_DRIVE_APP_ID VITE_PUBLIC_POSTHOG_KEY VITE_PUBLIC_POSTHOG_HOST Add them manually or delete your local file to re-copy from the example. setup-env: the following VITE_ vars are set but not listed in any example file: VITE_DEV_BYPASS_AUTH Add them to config/.env.example or config/.env.desktop.example if they are required. ``` If you add a new `VITE_*` variable to the codebase, add it to the appropriate `frontend/config/.env.example` file or the test will fail.
59 lines
2.1 KiB
TypeScript
59 lines
2.1 KiB
TypeScript
import '@mantine/core/styles.css';
|
|
import '@mantine/dates/styles.css';
|
|
import '../vite-env.d.ts'; // eslint-disable-line no-restricted-imports -- Outside app paths
|
|
import '@app/styles/index.css'; // Import global styles
|
|
import React from 'react';
|
|
import ReactDOM from 'react-dom/client';
|
|
import { ColorSchemeScript } from '@mantine/core';
|
|
import { BrowserRouter } from 'react-router-dom';
|
|
import App from '@app/App';
|
|
import '@app/i18n'; // Initialize i18next
|
|
import posthog from 'posthog-js';
|
|
import { PostHogProvider } from '@posthog/react';
|
|
import { BASE_PATH } from '@app/constants/app';
|
|
|
|
posthog.init(import.meta.env.VITE_PUBLIC_POSTHOG_KEY, {
|
|
api_host: import.meta.env.VITE_PUBLIC_POSTHOG_HOST,
|
|
defaults: '2025-05-24',
|
|
capture_exceptions: true, // This enables capturing exceptions using Error Tracking, set to false if you don't want this
|
|
debug: false,
|
|
opt_out_capturing_by_default: true, // Opt-out by default, controlled by cookie consent
|
|
persistence: 'memory', // No cookies/localStorage written until user opts in
|
|
cross_subdomain_cookie: false,
|
|
});
|
|
|
|
function updatePosthogConsent() {
|
|
if (!posthog.__loaded) return;
|
|
const optIn = (window.CookieConsent as any)?.acceptedService?.('posthog', 'analytics') || false;
|
|
if (optIn) {
|
|
posthog.set_config({ persistence: 'localStorage+cookie' });
|
|
posthog.opt_in_capturing();
|
|
} else {
|
|
posthog.opt_out_capturing();
|
|
posthog.set_config({ persistence: 'memory' });
|
|
}
|
|
console.log("Updated PostHog consent: ", optIn ? "opted in" : "opted out");
|
|
}
|
|
|
|
window.addEventListener("cc:onConsent", updatePosthogConsent);
|
|
window.addEventListener("cc:onChange", updatePosthogConsent);
|
|
|
|
const container = document.getElementById('root');
|
|
if (!container) {
|
|
throw new Error("Root container missing in index.html");
|
|
}
|
|
|
|
const root = ReactDOM.createRoot(container); // Finds the root DOM element
|
|
root.render(
|
|
<React.StrictMode>
|
|
<ColorSchemeScript />
|
|
<PostHogProvider
|
|
client={posthog}
|
|
>
|
|
<BrowserRouter basename={BASE_PATH}>
|
|
<App />
|
|
</BrowserRouter>
|
|
</PostHogProvider>
|
|
</React.StrictMode>
|
|
);
|