litlyx/README.md

🌐 Website 📚 Docs 🔥 Start for Free!

The easiest dev-centric analytics tool.
Litlyx is an open-source analytics solution for any JavaScript framework. Setup takes less then 30 seconds and just one line of code!

Pre-Requisites

Sign-up on Litlyx.com and create a project. Then simply use your project_id to connect Litlyx to your website OR Self-Host Litlyx with Docker.

Universal Installation

<script defer data-project="project_id_here" src="https://cdn.jsdelivr.net/gh/litlyx/litlyx-js/browser/litlyx.js"></script>

Importing Litlyx with a direct script instantly starts tracking 10 KPIs, including Page visits, Browsers, Devices, Operating Systems, Real-Time Online Users, Unique Sessions, Countries, and Average Session Time.

All Javascript Runtimes

You can install Litlyx using npm, yarn, or pnpm:

npm i litlyx-js

Litlyx natively works with all JavaScript / TypeScript frameworks. You can use Litlyx in all WordPress Websites by injecting JS code using a plug-in. Litlyx also works in serverless enviroments with Cloud (or Edge) Functions.

Import

Import litlyx-js library into your code:

import { Lit } from 'litlyx-js';

Once imported, you need to initialize Litlyx:

Lit.init('your_project_id');

After initialization, Litlyx will automatically track analytics such as Page visits, Browsers, Devices, Operating Systems, Real-Time Online Users, Unique Sessions, Countries, and Average Session Time.

Custom Events

You aren't just limited to the built-in KPIs. With Litlyx, you can create your own events to track in your project.

Lit.event('click_on_buy_item');

If you want more specific tracking, you can use the metadata field, like this:

Lit.event('click_on_buy_item', {
  metadata: {
    'product-name': 'Coca-Cola',
    'price': 1.50,
  }
});

Litlyx makes it easy for you to tailor your analytics to your project's needs.

AI Data-Analyst

Lit is an AI chatbot which you can use to compare data, query specific metadata, visualize charts, and much more with a simple conversation.

Self-Hosting with Docker

To self-host the Litlyx dashboard, first fork this repository.

Then run the following command:

docker-compose build

after the build finishes, run:

docker-compose up

at localhost:3000 you will see your own instance of the Litlyx Dashboard.

Official Docs

For more info read our documentation. (will be improved in the near future using Mintlify!)

Join Discord

If you need more information, help, or want to provide general feedback, feel free to join us on the Litlyx Discord

Contributors

Every kind of contribution is accepted in this stage of the project. In the future we will improve the contributor onboarding process.

Thank you!

License

Litlyx is licensed under the Apache 2.0 license.