From 9d851d1312918dd6753bb1a6174a0b8561f9f3b0 Mon Sep 17 00:00:00 2001 From: natterstefan Date: Mon, 16 Jul 2018 20:57:17 +0200 Subject: [PATCH] README and CHANGES added --- CHANGES.md | 9 +++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index 70d9d97..6c57428 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -8,10 +8,19 @@ adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ### Added +* component added for better and easier route management +* Google Analytics Feature: simply add `google_analytics_property` to the config.js + and enable Google Analytics on the page (including a privacy page.) Take a look + at the [README](README#google-analytics--privacy-page) to get to know the feature. +* CookieNotice component added, will be automatically present when Google Analytics + is configured +* Markdown files can be used to create content for a page (eg. a privacy page) * breakpoints constant added ### Changed +* jQuery (required for Trello), MaterialUI Fonts and Icons are self-hosted now +* component added to easier render Pages and their shared page components * UI improvements * customize scrollbars (horizontal and vertical) * Options toggle (show and hide) diff --git a/README.md b/README.md index 957b0ce..4234851 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ preferred team members. * [Trello API Key](#trello-api-key) * [Dependencies](#dependencies) * [Config.js](#configjs) + * [Google Analytics & Privacy Page](#google-analytics--privacy-page) * [URL Shortcuts & Bookmarks](#url-shortcuts--bookmarks) * [How to start the App locally](#how-to-start-the-app-locally) * [How to build the App for Production](#how-to-build-the-app-for-production) @@ -125,6 +126,7 @@ your needs and eg. enter your [API key][1] and other settings into the `config.j module.exports = { app_title: 'Multiboard for Trello®', api_key: 'your_api_key', + google_analytics_property: 'UA-12345678-9', company_member: 'exampleusername' preferred_members: /exampleusername|anotheruser/, lists: [/#sprint1/, /#sprint2/, /#sprint3/], @@ -144,6 +146,7 @@ The main config properties look like this: * `app_title`: name that appears in the Menubar and website title * `api_key`: your [trello api key][1] +* `google_analytics_property`: your Google Analytics property * `company_member`: representing the company and available on all cards, because this user is used to calculate the company estimations when all members are toggled @@ -197,6 +200,27 @@ Example: Would result in the following total estimation for the board: Example-Board \(6)\[1] +### Google Analytics & Privacy Page + +It is possible to integrate Google Analytics with pageviews by simply adding +`google_analytics_property` to the `config.js`. This will add +https://www.google-analytics.com/analytics.js to the app and track pageviews. +By default doNotTrack browser settings are respected. + +At the same time a privacy page (eg. http://localhost:2222/#/privacy) is created +and a CookieNotice presented to new users. The content can be defined in +[src/pages-content](src/pages-content) by adding a [privacy.md](src/pages-content/privacy.example.md) +file. + +By default [`gaOptout`](https://developers.google.com/analytics/devguides/collection/gajs/#disable) +is available to set a disable Google Analytics cookie in the user's browser. + +One can use it like this in the `privacy.md` file: + +```md +Or you deactivate it with a DoNotTrack Cookie: Deactive Google Analytics. +``` + ## URL Shortcuts & Bookmarks Certain url links can be used to eg. customize the inital lists and selected member: