forked/topola-viewer
1
0
Fork 0
mirror of https://github.com/PeWu/topola-viewer.git synced 2026-02-17 18:45:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Build configuration option to remove Google Analytics (#236)

Browse Source
This commit is contained in:
Adam Gross 2025-12-30 15:58:55 -08:00 committed by GitHub
parent 8b6d5a0939
commit ccdd732bbd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 47 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -136,6 +136,24 @@ set VITE_STATIC_URL=https://example.org/sample.ged && npm run build
The `dist/` folder will contain files that can be hosted on a Web server. The `dist/` folder will contain files that can be hosted on a Web server.
### Build without Google Analytics
Set `VITE_GOOGLE_ANALYTICS=false` to exclude Google Analytics from the build output. This will remove the external JavaScript dependency.
```shell
VITE_GOOGLE_ANALYTICS=false npm run build
```
<details>
<summary>For Windows CMD:</summary>
```cmd
set VITE_GOOGLE_ANALYTICS=false && npm run build
```
</details>
This may be combined with the other build environment variables described above.
### Alternative build ### Alternative build
The [topola-webpack](https://github.com/develancer/topola-webpack) tool can build a Topola Genealogy Viewer package bundled together with a GEDCOM file. The [topola-webpack](https://github.com/develancer/topola-webpack) tool can build a Topola Genealogy Viewer package bundled together with a GEDCOM file.

3
index.html
View File

@ -1,7 +1,7 @@
<!doctype html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Global site tag (gtag.js) - Google Analytics --> <!-- GOOGLE_ANALYTICS_START -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-32GXR2WF6S"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-32GXR2WF6S"></script>
<script> <script>
window.dataLayer = window.dataLayer || []; window.dataLayer = window.dataLayer || [];
@ -9,6 +9,7 @@
gtag('js', new Date()); gtag('js', new Date());
gtag('config', 'G-32GXR2WF6S'); gtag('config', 'G-32GXR2WF6S');
</script> </script>
<!-- GOOGLE_ANALYTICS_END -->
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="minimum-scale=1, initial-scale=1, width=device-width, shrink-to-fit=no"> <meta name="viewport" content="minimum-scale=1, initial-scale=1, width=device-width, shrink-to-fit=no">
<link rel="icon" href="favicon.png" type="image/png"/> <link rel="icon" href="favicon.png" type="image/png"/>

2
src/util/analytics_noop.ts Normal file
View File

@ -0,0 +1,2 @@
/** No-op function for analytics. */
export function analyticsEvent(action: string, data?: any) { }

26
vite.config.mts
View File

@ -1,11 +1,35 @@
import {defineConfig} from 'vite'; import {defineConfig} from 'vite';
import {resolve} from 'path';
import react from '@vitejs/plugin-react'; import react from '@vitejs/plugin-react';
import viteTsconfigPaths from 'vite-tsconfig-paths'; import viteTsconfigPaths from 'vite-tsconfig-paths';
export default defineConfig({ export default defineConfig({
// depending on your application, base can also be "/" // depending on your application, base can also be "/"
base: '', base: '',
plugins: [react(), viteTsconfigPaths()], plugins: [
react(),
viteTsconfigPaths(),
{
name: 'transform-index-plugin',
transformIndexHtml(html: string) {
// Remove Google Analytics code if VITE_GOOGLE_ANALYTICS is set to 'false'
if (process.env.VITE_GOOGLE_ANALYTICS?.trim() === 'false') {
return html.replace(/<!-- GOOGLE_ANALYTICS_START -->[\s\S]*?<!-- GOOGLE_ANALYTICS_END -->/, '');
}
},
},
],
resolve: {
alias: [
{
// Remove Google Analytics code if VITE_GOOGLE_ANALYTICS is set to 'false'
// Handles both formats of import statements used in this project
find: /\.?\.\/util\/analytics/, replacement: process.env.VITE_GOOGLE_ANALYTICS?.trim() === 'false'
? resolve(__dirname, 'src/util/analytics_noop.ts')
: resolve(__dirname, 'src/util/analytics.ts')
},
],
},
server: { server: {
// this ensures that the browser opens upon server start // this ensures that the browser opens upon server start
open: true, open: true,