@ucam.uis.devops/ucam-observe-remote-analytics

v1.0.0

Published

3 months ago

Tooling and documentation to provide a paved path for front-end/remote analytics. Currently utilising Google Analytics.

0High
0Medium
0Low

ucam-devops-bot

ucam-admin

logger

Remote and Front-end Analytics

Build

Run npm run build.

This will create a build in ./dist. This is an ESM-only target (you can't use this in CommonJS modules).
This will also make a tarball at ./ucam.uis.devops-ucam-observe-remote-analytics-analytics-x.y.z.tgz.

Installation

To install the package, run the following command:

npm i @ucam.uis.devops/ucam-observe-remote-analytics

Your app also needs to have react (version 17, 18 or 19) and mui (version 5, 6 or 7) installed. You probably already have these if you're following a react with mui template.

Required react dependencies: react react-dom
Required mui dependencies: @mui/material @emotion/react @emotion/styled @mui/icons-material. See https://mui.com/material-ui/getting-started/installation/

Tests

To run the tests, run npm test.

Usage

CookieBanner

Insert this next to the root of your React app.

❗️ Note
Use the CookieBanner in a ThemeProvider with the CamMuiTheme to get the correct style.

Before

    <html lang="en">
      <body className={inter.className}>
        {children}
      </body>
    </html>

After

    <html lang="en">
      <body className={inter.className}>
        <CookieBanner />
        {children}
      </body>
    </html>

CamMuiTheme

This is a theme that you can use with the ThemeProvider from material-ui. You should use the provider in your layout or highest-level React app component.

Before

    <html lang="en">
      <body className={inter.className}>
        <CookieBanner />
        {children}
      </body>
    </html>

After

    <html lang="en">
      <body className={inter.className}>
        <ThemeProvider theme={CamMuiTheme}>
          <CssBaseline />
          <CookieBanner />
          {children}
        </ThemeProvider>
      </body>
    </html>

Google Analytics Access

To gain access to Google Analytics and obtain your GA tracking code, follow these steps:

Login to Google Workspace: Use your @cam.ac.uk Cambridge account to log in via the Google Workspace Service Preferences.
Enable Google Analytics: In the Service Preferences web app, navigate to the "Google Analytics" section and enable it to activate your access to Google Analytics 4 (GA4).
Obtain Your GA Tracking Code:
- Once enabled, go to the Google Analytics dashboard.
- Create a new GA4 property if you haven't already.
- After setting up the property, you will receive a tracking ID in the format G-XXXXXXX. This is the code you will use to integrate Google Analytics into your project.
Manage Team Access:
- Ensure that the correct GA4 property is selected before proceeding.
- Navigate to the Admin section in your Google Analytics by selecting the gear icon at the bottom left.
- Go to 'Account Settings' -> 'Account Access Management' to add, edit, or remove team members.
Use the obtained GA tracking code (e.g., G-MJKN0LGYW0) in your project by configuring it within the analytics setup of your application.

If you encounter any issues or require further assistance, please refer to the Setting up Google Analytics and Google Search Console documentation.

Examples

In the basic-usage folder, you will find an example application.

To use it, start from the root folder, then run the following to install the package:

npm run build
pushd && cd basic-usage
npm i ../ucam.uis.devops-ucam-observe-remote-analytics-0.1.4.tgz
npm i

Then run the following to start the test app:

npm run dev

Go to localhost:3000 to see the application.

Contributing

This project is MIT licensed.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme