Enhance documentation and integrate Google Analytics
- Added an Analytics section to the README.md, detailing what is tracked, privacy measures, and opt-out instructions. - Implemented Google Analytics in index.html, including a privacy notice for open source users and environment-specific tracking IDs. - Updated worklenz-frontend README.md to include a License section.
This commit is contained in:
21
README.md
21
README.md
@@ -192,6 +192,27 @@ Email [info@worklenz.com](mailto:info@worklenz.com) to disclose any security vul
|
||||
|
||||
This project is licensed under the [MIT License](LICENSE).
|
||||
|
||||
## Analytics
|
||||
|
||||
Worklenz uses Google Analytics to understand how the application is being used. This helps us improve the application and make better decisions about future development.
|
||||
|
||||
### What We Track
|
||||
- Anonymous usage statistics
|
||||
- Page views and navigation patterns
|
||||
- Feature usage
|
||||
- Browser and device information
|
||||
|
||||
### Privacy
|
||||
- Analytics is opt-in only
|
||||
- No personal information is collected
|
||||
- Users can opt-out at any time
|
||||
- Data is stored according to Google's privacy policy
|
||||
|
||||
### How to Opt-Out
|
||||
If you've previously opted in and want to opt-out:
|
||||
1. Clear your browser's local storage for the Worklenz domain
|
||||
2. Or click the "Decline" button in the analytics notice if it appears
|
||||
|
||||
## Screenshots
|
||||
|
||||
<p align="center">
|
||||
|
||||
@@ -8,6 +8,7 @@ Worklenz is a project management application built with React, TypeScript, and A
|
||||
- [Project Structure](#project-structure)
|
||||
- [Contributing](#contributing)
|
||||
- [Learn More](#learn-more)
|
||||
- [License](#license)
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -93,3 +94,7 @@ To learn more about the technologies used in this project:
|
||||
- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
|
||||
- [Ant Design Documentation](https://ant.design/docs/react/introduce)
|
||||
- [Vite Documentation](https://vitejs.dev/guide/)
|
||||
|
||||
## License
|
||||
|
||||
Worklenz is open source and released under the [GNU Affero General Public License Version 3 (AGPLv3)](LICENSE).
|
||||
|
||||
@@ -14,6 +14,63 @@
|
||||
<title>Worklenz</title>
|
||||
<!-- Environment configuration -->
|
||||
<script src="/env-config.js"></script>
|
||||
<!-- Google Analytics -->
|
||||
<script>
|
||||
// Function to initialize Google Analytics
|
||||
function initGoogleAnalytics() {
|
||||
// Load the Google Analytics script
|
||||
const script = document.createElement('script');
|
||||
script.async = true;
|
||||
|
||||
// Determine which tracking ID to use based on the environment
|
||||
const isProduction = window.location.hostname === 'worklenz.com' ||
|
||||
window.location.hostname === 'app.worklenz.com';
|
||||
|
||||
const trackingId = isProduction
|
||||
? 'G-XXXXXXXXXX'
|
||||
: 'G-3LM2HGWEXG'; // Open source tracking ID
|
||||
|
||||
script.src = `https://www.googletagmanager.com/gtag/js?id=${trackingId}`;
|
||||
document.head.appendChild(script);
|
||||
|
||||
// Initialize Google Analytics
|
||||
window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
gtag('config', trackingId);
|
||||
}
|
||||
|
||||
// Initialize analytics
|
||||
initGoogleAnalytics();
|
||||
|
||||
// Show privacy notice only for open source version
|
||||
if (window.location.hostname !== 'worklenz.com' &&
|
||||
window.location.hostname !== 'app.worklenz.com' &&
|
||||
!localStorage.getItem('privacyNoticeShown')) {
|
||||
const notice = document.createElement('div');
|
||||
notice.style.cssText = `
|
||||
position: fixed;
|
||||
bottom: 20px;
|
||||
right: 20px;
|
||||
background: #fff;
|
||||
padding: 20px;
|
||||
border-radius: 8px;
|
||||
box-shadow: 0 2px 10px rgba(0,0,0,0.1);
|
||||
z-index: 1000;
|
||||
max-width: 400px;
|
||||
font-family: Inter, sans-serif;
|
||||
`;
|
||||
notice.innerHTML = `
|
||||
<h3 style="margin-top: 0;">Analytics Notice</h3>
|
||||
<p>This open source project uses Google Analytics to understand usage patterns and improve the application.</p>
|
||||
<p>We only collect anonymous usage data. No personal information is tracked.</p>
|
||||
<div style="display: flex; gap: 10px; margin-top: 15px;">
|
||||
<button onclick="this.parentElement.parentElement.remove(); localStorage.setItem('privacyNoticeShown', 'true');" style="padding: 8px 16px; background: #1890ff; color: white; border: none; border-radius: 4px; cursor: pointer;">Got it</button>
|
||||
</div>
|
||||
`;
|
||||
document.body.appendChild(notice);
|
||||
}
|
||||
</script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
Reference in New Issue
Block a user