Umami React

Introduction

The Umami Analytics Loader is a lightweight script that enables you to easily integrate Umami Analytics into your website. Umami is a simple, open-source website analytics tool that provides valuable insights into your website's traffic without compromising privacy.

Features

Lightweight: The Umami Analytics Loader is a lightweight script that won't slow down your website.
Easy to Use: Simply add the script to your website and start tracking your website's traffic.
Privacy-Focused: Umami Analytics is privacy-focused and doesn't track personal data.
Open Source: Umami Analytics is open-source and free to use.
Customizable: You can customize the script to suit your needs.

Installation

To install the Umami Analytics Loader, follow these steps:

npm i @danielgietmann/umami-react

yarn add @danielgietmann/umami-react

pnpm add @danielgietmann/umami-react

Usage

To use the Umami Analytics Loader, follow these steps: In the Main Layout File Add the UmamiAnalytics Component to the Body of your Website

import {UmamiAnalytics} from "@danielgietmann/umami-react";

function App() {
  return (
      <html lang="en">
            <body>
                <UmamiAnalytics/>
                {children}
            </body>
        </html>

  )
}

Options

Set in your .env File

Option	Type	Description	Default
UMAMI_URL	`string`	The URL of your Umami Instance	`""`
UMAMI_ID	`string`	The ID of your Umami Instance	`""`
UMAMI_DEBUG	`string`	The ID of your Umami Instance	`"false"`

Roadmap

Cookies Check (DSGVO)

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Last modified: 03 August 2024