@ucam.uis.devops/ucam-observe-remote-analytics
v0.1.0
Published
Tooling and documentation to provide a paved path for front-end/remote analytics. Currently utilising Google Analytics.
Downloads
4
Readme
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-analyticsUsage
CookieBanner
Insert this next to the root of your React app.
❗️ Note
Use the
CookieBannerin aThemeProviderwith theCamMuiThemeto 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>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.0.tgz
npm iThen run the following to start the test app:
npm run devGo to localhost:3000 to see the application.
Contributing
This project is MIT licensed.