📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
Rewrite README for better user conversion
Andrii Romasiuncf5614f4cdd4
diff --git a/README.md b/README.mdindex 9c593f504..8c3f1ec8b 100644--- a/README.md+++ b/README.md@@ -2,15 +2,15 @@<p align="center"><a href="https://github.com/Swetrix/swetrix">- <img src="https://swetrix.com/assets/readme-image.png?v=3" alt="Logo">+ <img src="https://swetrix.com/assets/readme-image.png?v=3" alt="Swetrix"></a><h3 align="center">Swetrix</h3><p align="center">- Open source, cookieless web analytics.+ Privacy-first, open-source web analytics — with error tracking, session replays and performance monitoring built in.<br />- <a href="https://swetrix.com"><strong>Learn more »</strong></a>+ <a href="https://swetrix.com/demo"><strong>See the live demo »</strong></a><br /><br /><a href="https://swetrix.com">Website</a>@@ -22,97 +22,116 @@<a href="https://swetrix.com/discord">Discord</a>·<a href="https://x.com/swetrix">Twitter</a>- ·- <a href="https://x.com/andrii_rom">Author</a></p></p>-## ℹ️ About the Project--[Swetrix](https://swetrix.com) is an open source, privacy-focused and cookie-less alternative to Google Analytics. Swetrix is designed to be easy to use while providing all the features you need to understand your website users. With Swetrix you can track your site's traffic, monitor your site's speed, analyse user sessions and page flows, see user flows and much more!--Swetrix is made in the 🇬🇧 United Kingdom, and is hosted on Hetzner in 🇩🇪 Germany. Here's our [live demo with our own website statistics](https://swetrix.com/demo).--We are a bootstrapped company that is passionate about privacy and open source, funded solely by our subscribers.+<p align="center">+ <a href="https://swetrix.com"><img src="https://img.shields.io/badge/Try%20Swetrix%20Cloud-free%20trial-1d4ed8" alt="Try Swetrix Cloud"></a>+ <a href="https://docs.swetrix.com/selfhosting/how-to"><img src="https://img.shields.io/badge/Self--host-with%20Docker-555" alt="Self-host with Docker"></a>+ <a href="https://github.com/Swetrix/swetrix/stargazers"><img src="https://img.shields.io/github/stars/Swetrix/swetrix?style=flat&label=Stars" alt="GitHub stars"></a>+ <a href="./LICENSE"><img src="https://img.shields.io/badge/license-AGPLv3-green" alt="License"></a>+</p><picture><source media="(prefers-color-scheme: dark)" srcset="https://swetrix.com/assets/screenshot_dark.png?v=1">- <img alt="Swetrix Dashboard demonstration" src="https://swetrix.com/assets/screenshot_light.png?v=1">+ <img alt="Swetrix dashboard" src="https://swetrix.com/assets/screenshot_light.png?v=1"></picture>-## ✨ Why Swetrix?+## ℹ️ What is Swetrix?-We've been building Swetrix since 2021 with a goal to make web analytics simple and respectful of your users' privacy.+[Swetrix](https://swetrix.com) is a cookieless, GDPR-compliant analytics platform — a privacy-respecting alternative to Google Analytics. No cookies, no consent banner, no cross-device tracking, all data anonymised. It's the only thing on the page and the dashboard is fast and real-time.-- **Privacy‑first and cookieless**: GDPR‑compliant by design. We don't use cookies, cross-device tracking, all the data is stored anonymised. Read more in our [Data Policy](https://swetrix.com/data-policy) page.-- **Lightweight and fast**: a small tracking script and a snappy, real‑time dashboard.-- **Core insights that matter**: top pages, geolocation, map visualisation, devices, traffic sources and UTM campaigns.-- **Network intelligence**: break traffic down by ISP, organisation, usage type (residential, business, hosting, cellular...) and connection type to spot bot/datacenter traffic and understand who your audience really is.-- **Custom events and properties**: track conversions, sales, or key user actions with your own semantics.-- **Session analytics and user flows**: understand journeys and behaviour across your site.-- **Session replays (Cloud)**: replay user sessions to investigate UX issues and understand where visitors get stuck.-- **Funnels**: visualise drop‑offs and improve conversion rates.-- **Performance monitoring**: real‑user metrics (e.g. TTFB, DNS, TLS, render) to keep sites fast.-- **Error tracking**: capture client‑side errors with details and aggregated views.-- **Shareable analytics**: public or password‑protected dashboards; invite teammates with roles, or manage access with organisations.-- **Data portability**: export to CSV and access data via our [developer API](https://docs.swetrix.com/statistics-api).-- **Alerts & notifications (Cloud)**: get notified on thresholds via Email, Slack, Telegram, Discord, generic outbound webhook or browser web push, with per-alert custom message templates.-- **Feature flags**: manage feature rollouts and conduct safe releases.-- **Experiments (Cloud)**: run A/B tests and experiments to optimize your site.-- **Revenue analytics (Cloud)**: track MRR, churn and other financial metrics.-- **Ask AI (Cloud)**: chat with your data to uncover insights.-- **Goals**: track specific conversion goals and objectives.-- **DAU/MAU tracking**: keep an eye on your daily and monthly active users.-- Open source and self‑hostable, with a fully managed EU‑hosted Cloud option.+It goes beyond pageviews: alongside traffic stats you get **error tracking**, **performance monitoring**, **session replays**, **funnels** and **custom events** — so you can replace several tools with one.-## 🚀 Getting Started+Open source since 2021, bootstrapped, and funded entirely by our subscribers. Made in the 🇬🇧 UK, hosted on Hetzner in 🇩🇪 Germany.-The easiest way to get started with Swetrix is by using [our cloud service](https://swetrix.com). We do all the work for you: hosting, maintenance, backups, worldwide CDN, etc. Using Cloud you still own the data, you can export it or delete it at any time you want. It's GDPR‑compliant, hosted in the EU (Germany), with a free trial available.+👉 **[Try it free on Swetrix Cloud](https://swetrix.com)** or **[self-host with Docker](https://docs.swetrix.com/selfhosting/how-to)**.-We're an independent and bootstrapped company, your subscription to Swetrix Cloud directly supports maintenance and development of the project, which eventually makes it better.+## ✨ Features-- Start using Cloud: https://swetrix.com (starts at $19/mo with a free trial available)-- Explore docs: https://docs.swetrix.com+- **Cookieless & privacy-first** — GDPR-compliant by design, no cookies, anonymised data. ([Data Policy](https://swetrix.com/data-policy))+- **Lightweight script** — a small tracking snippet and a snappy real-time dashboard.+- **The metrics that matter** — top pages, geolocation with map view, devices, traffic sources and UTM campaigns.+- **Network intelligence** *(Cloud)* — break traffic down by ISP, organisation, usage type (residential / business / hosting / cellular) and connection type to spot bot and datacenter traffic.+- **Custom events & properties** — track conversions, sales or any key action with your own semantics.+- **Sessions & user flows** — understand journeys and behaviour across your site.+- **Funnels** — visualise drop-offs and improve conversion rates.+- **Performance monitoring** — real-user metrics (TTFB, DNS, TLS, render) to keep pages fast.+- **Error tracking** — capture client-side errors with details and aggregated views.+- **Session replays** *(Cloud)* — replay sessions to see exactly where visitors get stuck.+- **Sharing & teams** — public or password-protected dashboards; invite teammates with roles, or manage access with organisations.+- **Data portability** — export to CSV and access everything via the [developer API](https://docs.swetrix.com/statistics-api).+- **More** — alerts & notifications, feature flags, A/B experiments, revenue analytics and Ask AI *(Cloud)*.-### Selfhosting+## Swetrix vs Google Analytics vs Plausible-Prefer to run it yourself? Swetrix Community Edition (CE) ships the same core analytics: privacy‑friendly traffic stats, custom events, sessions, funnels, performance and error tracking. Use Docker to deploy the API and UI, connect MySQL/ClickHouse/Redis, and you're ready to go.+Swetrix and Plausible are both privacy-first and open source; the main difference is scope — Swetrix bundles error tracking, performance monitoring and session replays into the same product.-- Self‑hosting guide: https://docs.swetrix.com/selfhosting/how-to+| | **Swetrix** | Google Analytics 4 | Plausible |+| -------------------------------- | ---------------------- | ----------------------- | -------------------- |+| Cookieless, no consent banner | ✅ | ❌ cookies + consent | ✅ |+| GDPR-compliant, EU-hosted | ✅ | ⚠️ data sent to US | ✅ |+| Open source (AGPLv3) | ✅ | ❌ | ✅ |+| Self-hostable | ✅ | ❌ | ✅ |+| No data sampling | ✅ | ❌ samples at scale | ✅ |+| Real-time dashboard | ✅ | ⚠️ limited | ✅ |+| Funnels | ✅ | ✅ | ✅ (paid plans) |+| Custom events | ✅ | ✅ | ✅ |+| Performance monitoring | ✅ | ❌ | ❌ |+| Error tracking | ✅ | ❌ | ❌ |+| Session replays | ✅ Cloud | ❌ | ❌ |+| Feature flags & A/B experiments | ✅ Cloud | ❌ | ❌ |+| Revenue / MRR analytics | ✅ Cloud | ⚠️ ecommerce setup | ❌ |+| Ask AI / chat with your data | ✅ Cloud | ❌ | ❌ |+| User profiles / identified users | ✅ Cloud | ❌ | ❌ |-Cloud vs Community Edition+## 🚀 Get started-| | Swetrix Cloud | Swetrix Community Edition |-| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| **Infrastructure management** | ✅ It's easy to get started with Swetrix Cloud - you can set up tracking in a matter of minutes. We manage server maintenance, upgrades, security for you. | ⚠️ You are responsible for managing servers, installs, upgrades, scaling and backups. |-| **Core analytics (traffic, events, sessions, funnels, performance, errors)** | ✅ Included | ✅ Included |-| **Session replays** | ✅ Included | ⚠️ Cloud only; not included in CE |-| **Advanced features (Revenue, Experiments, AI)** | ✅ Included | ⚠️ Cloud only; not included in CE |-| **Teams & sharing** | ✅ Organisations to manage multiple projects and users with permissions setup; invite people to your projects directly, or share a public or password protected link with people. | ⚠️ Only direct project invites, password protected links and public projects are supported. |-| **Alerts & notifications** | ✅ Yes (Email, Slack, Telegram, Discord, webhook, web push) | ⚠️ Not included |-| **Email reports** | ✅ Yes (weekly/monthly/quarterly) | ⚠️ Not included |-| **Geo & network analytics** | ✅ Swetrix Cloud uses a premium GeoIP database to provide consistent and accurate country / region / city geolocation, plus ISP, organisation, usage type and connection type. | ⚠️ Less accurate, DB-IP City Lite Database (country / region / city only); you need a paid MaxMind or DB-IP database for ISP and network-intelligence breakdowns. |-| **Release schedule** | ✅ Continuously developed with updates deployed as soon as they are ready | ℹ️ Periodic open‑source releases, latest features are not available immediately. |-| **Support** | ✅ Premium support from the people who build and maintain Swetrix | ⚠️ Official support is not included. Community‑driven support on Discord or other forums only. |-| **Costs** | ✅ We're an independent and bootstrapped business, your money directly supports Swetrix development. | ⚠️ You pay for the server costs and maintenance, backups, domains and other selfhosting costs, with money going to 3rd party services with no connection to us. |+### Swetrix Cloud (recommended)-## Tech Stack+We handle hosting, maintenance, backups and a worldwide CDN — you keep full ownership of your data and can export or delete it anytime. GDPR-compliant and hosted in the EU.-Backend / API is built as a standard Nest.js application. We use MySQL with TypeORM for general data (accounts, projects, etc.), and Clickhouse for analytics data. Redis is used for caching.+- **[Start free →](https://swetrix.com)** — free trial, then from $19/mo+- **[Live demo →](https://swetrix.com/demo)**+- **[Docs →](https://docs.swetrix.com)**-Frontend is built using React Router framework. We use Tailwind CSS for styling and billboard.js for charts.+Your subscription directly funds maintenance and development of the open-source project.-The [browser tracking script](https://github.com/Swetrix/swetrix-js) is built with TypeScript and rollup for bundling.+### Self-hosting-## 🤝 Contributing+Prefer to run it yourself? Swetrix Community Edition (CE) ships the same core analytics: privacy-friendly traffic stats, custom events, sessions, funnels, performance and error tracking. Deploy the API and UI with Docker, connect MySQL / ClickHouse / Redis, and you're live.-See our [contributing guide](./CONTRIBUTING.MD) to get started. We welcome any contribution to the project!+- **[Self-hosting guide →](https://docs.swetrix.com/selfhosting/how-to)**-Feel free to go through our [open issues](https://github.com/Swetrix/swetrix/issues) and pick any task you want to work on.+#### Cloud vs Community Edition++| | Swetrix Cloud | Swetrix Community Edition |+| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| **Infrastructure management** | ✅ Set up tracking in minutes. We manage server maintenance, upgrades and security for you. | ⚠️ You manage servers, installs, upgrades, scaling and backups. |+| **Core analytics (traffic, events, sessions, funnels, performance, errors)** | ✅ Included | ✅ Included |+| **Session replays** | ✅ Included | ⚠️ Cloud only |+| **Advanced features (Revenue, Experiments, AI)** | ✅ Included | ⚠️ Cloud only |+| **Teams & sharing** | ✅ Organisations, role-based access, direct invites, public and password-protected links. | ⚠️ Direct project invites, password-protected links and public projects only. |+| **Alerts & notifications** | ✅ Email, Slack, Telegram, Discord, webhook, web push | ⚠️ Not included |+| **Email reports** | ✅ Weekly / monthly / quarterly | ⚠️ Not included |+| **Geo & network analytics** | ✅ Premium GeoIP for accurate country / region / city, plus ISP, organisation, usage type and connection type. | ⚠️ DB-IP City Lite (country / region / city only); a paid MaxMind or DB-IP database is needed for network breakdowns. |+| **Release schedule** | ✅ Continuous updates, deployed as soon as ready | ℹ️ Periodic open-source releases; newest features arrive later. |+| **Support** | ✅ Premium support from the team building Swetrix | ⚠️ Community support on Discord and forums. |+| **Costs** | ✅ Bootstrapped business — your money directly funds Swetrix development. | ⚠️ You pay for servers, maintenance, backups and domains. |++## 🛠️ Tech stack++- **Backend / API** — Nest.js, MySQL + TypeORM (accounts, projects), ClickHouse (analytics), Redis (caching).+- **Frontend** — React Router, Tailwind CSS, billboard.js for charts.+- **Tracking script** — [`packages/tracker-js`](./packages/tracker-js), the `swetrix` npm client, TypeScript bundled with rollup.++## 🤝 Contributing++We welcome contributions! See the [contributing guide](./CONTRIBUTING.MD) and browse [open issues](https://github.com/Swetrix/swetrix/issues) to pick something up.## ⭐️ Star History-Star us on GitHub — your support motivates us a lot! 😊+If Swetrix is useful to you, **star the repo** — it genuinely helps a bootstrapped team and motivates us a lot 😊<a href="https://www.star-history.com/#swetrix/swetrix&type=date&legend=top-left"><picture>@@ -122,21 +141,17 @@ Star us on GitHub — your support motivates us a lot! 😊</picture></a>-## 💬 Contacts--To talk to our sales team for any commercial inquiries, ask us a question or just say hi 👋, you can contact us via:+## 💬 Contact- **Email:** [email protected]-- **Book a call:** we're happy to do a demo or sales call with you, you can book it at https://cal.com/swetrix-- **Discord:** join our [Discord community](https://swetrix.com/discord)-- **Twitter:** follow us on [Twitter](https://x.com/swetrix)-- **Author:** you can follow me (Andrii) on X too ☺️. I post about Swetrix and solopreneurship journey on [@andrii_rom](https://x.com/andrii_rom)+- **Book a call:** [swetrix.com/book-a-call](https://swetrix.com/book-a-call)+- **Discord:** [join the community](https://swetrix.com/discord)+- **Twitter:** [@swetrix](https://x.com/swetrix)+- **Author:** I post about Swetrix and solopreneurship at [@andrii_rom](https://x.com/andrii_rom)## 📃 License-Swetrix Community Edition is open source under the GNU Affero General Public License Version 3 (AGPLv3). The license can be found in the [LICENSE](./LICENSE) file.--Source code contributions are subject to the [Contributor License Agreement](https://gist.github.com/Blaumaus/cb232e7c2506b9feec188194a77cb9f9).+Swetrix Community Edition is open source under the GNU Affero General Public License v3 (AGPLv3). See the [LICENSE](./LICENSE) file. Source code contributions are subject to the [Contributor License Agreement](https://gist.github.com/Blaumaus/cb232e7c2506b9feec188194a77cb9f9).© 2021 - present, Swetrix Ltd.