vince

README

⚠ This is still under early development its not in a usable state yet.

vince

The Cloud Native Web Analytics Platform. Built on Apache Arrow and Apache Parquet.

Features

• SQL for querying stats (All MySQL compatible clients are supported)
• Time on site tracking
• Conversion tracking
• Multiple site management
• User Interaction Management
• Campaign Management
• Report Generation
• Goal Tracking
• Event Tracking
• Cloud Native (seamless k8s integration)
• API for sites management
• No runtime dependency (Static binary with everything you need)

Usage

Install

curl -fsSL https://github.com/vinceanalytics/vince/releases/latest/download/install.sh | bash

brew install vinceanalytics/tap/vince

docker pull ghcr.io/vinceanalytics/vince

Initialize a project

VINCE_ROOT_PASSWORD=xxxxx vince init example

Serve analytics collection api and web console

Start server

vince serve example

The script for embedding will be served under localhost:8080/js/vince.js. Web analytics events are collected on localhost:8080/api/events endpoint.

Contributing

UI

Console ui lives in ./ui/ directory. We are using react with @primer/react components. For the code editor we use Monaco

requirement:

• Latest node version
• Latest go version go1.21+

You need go version because we embed the generated app, so only way to test it/develop is to run embedding step then access your work through vince serve

When you are done making changes

go generate 

Will take care of building/embedding and start the server for you. Note that for this all to work., you must create development project in .vince directory.

Basically steps to getting started

• Clone and cd into vince root
• Install and setup go1.21+
• Install latest node version
• go install
• VINCE_ROOT_PASSWORD=xxxxx vince init .vince

Then you can work on files in ./ui/ when done.

go generate

You can now access the ui with your changes on localhost:8080

Backend

You only need the latest Go version go1.21+

We recommend using go install when developing.