Skip to content

SAYOUNCDR/okunix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

211 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Okunix Analytics

A lightweight, privacy-focused analytics engine built for modern web applications.

Website Link 1Website Link 2GitHub RepositoryAPI Reference


Okunix is a powerful, self-hostable web analytics platform designed to track, aggregate, and visualize key telemetry metrics in real-time. Built with a focus on simplicity and performance, Okunix provides developers with immediate insights into their application traffic without compromising end-user privacy.

Core Features

Telemetry & Metrics

  • Live Viewers: Real-time websocket tracking of concurrent active sessions.
  • Traffic Analytics: Accurate aggregation of Unique Visitors and Total Visits.
  • Engagement Tracking: Automated Bounce Rate calculation and Session Duration tracking.

Data Visualization

  • Geographic Distribution: Interactive world mapping and detailed tabular breakdown by Country, Region, and City.
  • Traffic Heatmaps: visual matrix representations of activity intensity sorted by day and operational hours (24h).
  • Environment Profiling: Device, Operating System, and Browser telemetry extraction.

Deep Routing Analytics

  • Referrer Attribution: Track incoming traffic channels (Social Media, Direct, Organic Search).
  • Path Analysis: Monitor specific route performance, visualizing standard pageviews alongside Entry and Exit nodes.

Architecture & Technology Stack

Okunix is built on the MERN stack, delivering high-performance telemetry processing via Node.js streams and efficient aggregation pipelines via MongoDB.

  • Frontend: React.js, TailwindCSS, Chart.js, Lucide Icons
  • Backend: Node.js, Express.js (See API Reference)
  • Database: MongoDB & Mongoose ORM
  • Authentication: JWT-based stateless authentication

Getting Started

Prerequisites

Ensure the following runtimes and services are available on your host machine:

  • Node.js (v18.0.0 or higher)
  • MongoDB (v6.0 or higher)
  • npm or yarn package manager

Local Installation

  1. Clone the repository

    git clone https://github.com/SAYOUNCDR/okunix.git
    cd okunix
  2. Install Backend Dependencies

    cd server
    npm install
  3. Install Frontend Dependencies

    cd ../client
    npm install
  4. Environment Configuration

    Server Environment Variables

    Create a .env file in the server directory by copying the .env.example file.

    cd server
    cp .env.example .env

    Client Environment Variables - Must Read the .env.example in client directory for /api setup

    Create a .env file in the client directory by copying the .env.example file.

    cd client
    cp .env.example .env
  5. Initialize the Application

    # Terminal 1: Start the Backend API
    cd server
    npm run dev
    
    # Terminal 2: Start the React Client
    cd client
    npm run dev

Integration Guide

To begin tracking analytics on a target website, embed the Okunix tracking script into the <head> of your application. The script acts as an asynchronous unblocking beacon.

<script
  defer
  src="https://okunix.tech/api/tracker/script.js"
  data-website-id="YOUR_WEBSITE_ID"
></script>

Contributing

We welcome contributions to the Okunix engine. Please read through our open issues or submit a detailed Pull Request outlining your proposed architectural changes.

License

This project is generously open-sourced and available under the MIT License.

About

A lightweight , easy to setup and self-hostable web analytics platform. Tracks Visitoes, Visits, Bounce rate, Device type and OS. ( Website is down rn, vm cost)

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages