chore: update readme
This commit is contained in:
49
README.md
49
README.md
@@ -25,9 +25,40 @@
|
||||
|
||||
Openpanel is an open-source web and product analytics platform that combines the power of Mixpanel with the ease of Plausible and one of the best Google Analytics replacements.
|
||||
|
||||
## Disclaimer
|
||||
## ✨ Features
|
||||
|
||||
> Hey folks 👋🏻 Just a friendly heads-up: we're still in the early stages of this project. We have migrated from pages to app dir and made some major changes during the development of Openpanel, so everything is not perfect.
|
||||
- **🔍 Advanced Analytics**: Funnels, cohorts, user profiles, and session history
|
||||
- **📊 Real-time Dashboards**: Live data updates and interactive charts
|
||||
- **🎯 A/B Testing**: Built-in variant testing with detailed breakdowns
|
||||
- **🔔 Smart Notifications**: Event and funnel-based alerts
|
||||
- **🌍 Privacy-First**: Cookieless tracking and GDPR compliance
|
||||
- **🚀 Developer-Friendly**: Comprehensive SDKs and API access
|
||||
- **📦 Self-Hosted**: Full control over your data and infrastructure
|
||||
- **💸 Transparent Pricing**: No hidden costs or usage limits
|
||||
- **🛠️ Custom Dashboards**: Flexible chart creation and data visualization
|
||||
- **📱 Multi-Platform**: Web, mobile (iOS/Android), and server-side tracking
|
||||
|
||||
## 📊 Analytics Platform Comparison
|
||||
|
||||
| Feature | OpenPanel | Mixpanel | GA4 | Plausible |
|
||||
|----------------------------------------|-----------|----------|-----------|-----------|
|
||||
| ✅ Open-source | ✅ | ❌ | ❌ | ✅ |
|
||||
| 🧩 Self-hosting supported | ✅ | ❌ | ❌ | ✅ |
|
||||
| 🔒 Cookieless by default | ✅ | ❌ | ❌ | ✅ |
|
||||
| 🔁 Real-time dashboards | ✅ | ✅ | ❌ | ✅ |
|
||||
| 🔍 Funnels & cohort analysis | ✅ | ✅ | ✅* | ✅*** |
|
||||
| 👤 User profiles & session history | ✅ | ✅ | ❌ | ❌ |
|
||||
| 📈 Custom dashboards & charts | ✅ | ✅ | ✅ | ❌ |
|
||||
| 💬 Event & funnel notifications | ✅ | ✅ | ❌ | ❌ |
|
||||
| 🌍 GDPR-compliant tracking | ✅ | ✅ | ❌** | ✅ |
|
||||
| 📦 SDKs (Web, Swift, Kotlin, ReactNative) | ✅ | ✅ | ✅ | ❌ |
|
||||
| 💸 Transparent pricing | ✅ | ❌ | ✅* | ✅ |
|
||||
| 🚀 Built for developers | ✅ | ✅ | ❌ | ✅ |
|
||||
| 🔧 A/B testing & variant breakdowns | ✅ | ✅ | ❌ | ❌ |
|
||||
|
||||
> ✅* GA4 has a free tier but often requires BigQuery (paid) for raw data access.
|
||||
> ❌** GA4 has faced GDPR bans in several EU countries due to data transfers to US-based servers.
|
||||
> ✅*** Plausible has simple goals
|
||||
|
||||
## Stack
|
||||
|
||||
@@ -37,6 +68,7 @@ Openpanel is an open-source web and product analytics platform that combines the
|
||||
- **Clickhouse** - storing events
|
||||
- **Redis** - cache layer, pub/sub and queue
|
||||
- **BullMQ** - queue
|
||||
- **GroupMQ** - for grouped queue
|
||||
- **Resend** - email
|
||||
- **Arctic** - oauth
|
||||
- **Oslo** - auth
|
||||
@@ -63,15 +95,6 @@ You can find the how to [here](https://openpanel.dev/docs/self-hosting/self-host
|
||||
- Node
|
||||
- pnpm
|
||||
|
||||
### Setup
|
||||
|
||||
Add the following to your hosts file (`/etc/hosts` on mac/linux or `C:\Windows\System32\drivers\etc\hosts` on windows). This will be your local domain.
|
||||
|
||||
```
|
||||
127.0.0.1 op.local
|
||||
127.0.0.1 api.op.local
|
||||
```
|
||||
|
||||
### Start
|
||||
|
||||
```bash
|
||||
@@ -83,8 +106,8 @@ pnpm dev
|
||||
|
||||
You can now access the following:
|
||||
|
||||
- Dashboard: https://op.local
|
||||
- API: https://api.op.local
|
||||
- Dashboard: https://localhost:3000
|
||||
- API: https://api.localhost:3333
|
||||
- Bullboard (queue): http://localhost:9999
|
||||
- `pnpm dock:ch` to access clickhouse terminal
|
||||
- `pnpm dock:redis` to access redis terminal
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 336 KiB After Width: | Height: | Size: 208 KiB |
BIN
apps/public/public/ogimage.png
Normal file
BIN
apps/public/public/ogimage.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 681 KiB |
Reference in New Issue
Block a user