# pirsch

> Pirsch Analytics.

Latest version **1.7.2** (published 2020-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install pirsch
pnpm add pirsch
yarn add pirsch
bun add pirsch
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.7.2 |
| Published | 2020-10-29 |
| First published | 2020-10-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1030 |
| Author | Emvi Software GmbH |
| Maintainers | kugel |
| Keywords | pirsch, tracking, analytics |

## Links

- npm: https://www.npmjs.com/package/pirsch
- Repository: https://github.com/pirsch-analytics/pirsch
- Homepage: https://github.com/pirsch-analytics/pirsch#readme
- Issues: https://github.com/pirsch-analytics/pirsch/issues
- npm.io page: https://npm.io/package/pirsch

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.7.2 (latest) — 2020-10-29
- 1.6.0 — 2020-10-29
- 1.0.1 — 2020-10-01
- 1.0.0 — 2020-10-01

## README

<img src="logo.svg" alt="Pirsch Logo" width="26" />

# Pirsch Analytics

[![Go Reference](https://pkg.go.dev/badge/github.com/pirsch-analytics/pirsch?status.svg)](https://pkg.go.dev/github.com/pirsch-analytics/pirsch/v7)
[![Go Report Card](https://goreportcard.com/badge/github.com/pirsch-analytics/pirsch/v7)](https://goreportcard.com/report/github.com/pirsch-analytics/pirsch/v7)

This is the open-source core of [Pirsch Analytics](https://pirsch.io), a privacy-friendly web analytics solution. It originally started as an [experiment](https://marvinblum.de/blog/server-side-tracking-without-cookies-in-go-OxdzmGZ1Bl) to reliably analyze web traffic from the server-side using Go.

Pirsch is made in the EU 🇪🇺 and hosted on German 🇩🇪 owned servers at [Hetzner](https://www.hetzner.com/). You can find an interactive demo of what the dashboard looks like today [here](https://pirsch.pirsch.io).

## How does it work?

Pirsch generates a unique fingerprint for each visitor. The fingerprint is a hash of the visitors IP address, User-Agent, the date, and a salt.  The tracking works without invading the visitor's privacy. It doesn't use cookies and no personal information is stored, making it GDPR-, CCPA-, and PECR-compliant. If used on the server-side, Pirsch can track visitors using ad blockers.

[Learn more about privacy on our documentation.](https://docs.pirsch.io/privacy)

## Documentation

You can find our documentation [here](https://docs.pirsch.io). The code reference can be found on [go.dev](https://pkg.go.dev/github.com/pirsch-analytics/pirsch/v7).

## Contributions

Contributions are welcome! Please open a pull requests for your changes and tickets in case you would like to discuss something or have a question.

To run the tests you'll need a ClickHouse database and a schema called `pirschtest`. The user is set to `default` (no password).

Note that we only accept pull requests if you transfer the ownership of your contribution to us. As we also offer a managed commercial solution with this library at its core, we want to make sure we can keep control over the source code.

## License

GNU AGPLv3

---
_Source: https://npm.io/package/pirsch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._