Elizhium/litlyx
1
0
Fork 0
mirror of https://github.com/Litlyx/litlyx synced 2025-12-09 23:48:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12 from bradenhirschi/readme

Browse Source 
Updated readme for better English
This commit is contained in:
Antonio Verdiglione
2024-08-19 15:59:36 +02:00
committed by GitHub
parent 1b88bad32d 887ed45b4d
commit c1bdc30933
1 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -7,12 +7,16 @@
🌐 <a href="https://litlyx.com">Website</a> 📚 <a href="https://docs.litlyx.com">Docs</a> 🔥 <a href="https://dashboard.litlyx.com">Start for Free!</a> 🌐 <a href="https://litlyx.com">Website</a> 📚 <a href="https://docs.litlyx.com">Docs</a> 🔥 <a href="https://dashboard.litlyx.com">Start for Free!</a>
</h4> </h4>
![GitHub Repo stars](https://img.shields.io/github/stars/Litlyx/litlyx)
![NPM Version](https://img.shields.io/npm/v/litlyx?logo=npm&color=orange)
![npm bundle size](https://img.shields.io/bundlephobia/min/litlyx)
<br /> <br />
# #
<p align="center"> <p align="center">
The easiest Dev-Centric Analytics tool.<br>Litlyx is , Open-Source, Plug-In everywhere Javascript is Supported. Setup in less then 30 seconds, with just One-Line of code. The easiest dev-centric analytics tool.<br>Litlyx is an open-source analytics solution for any JavaScript framework. Setup takes less then 30 seconds and just one line of code!
</p> </p>
# #
@@ -25,13 +29,9 @@
# #
![GitHub Repo stars](https://img.shields.io/github/stars/Litlyx/litlyx)
![NPM Version](https://img.shields.io/npm/v/litlyx?logo=npm&color=orange)
![npm bundle size](https://img.shields.io/bundlephobia/min/litlyx)
## Pre-Requisites ## Pre-Requisites
Sign-up on [Litlyx cloud](https://dashboard.litlyx.com) using OAuth & name your project to get your project_id to connect Litlyx to your website OR Self-Host Litlyx with Docker. Sign-up on [Litlyx.com](https://dashboard.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 ## Universal Installation
@@ -39,7 +39,7 @@ Sign-up on [Litlyx cloud](https://dashboard.litlyx.com) using OAuth & name your
<script defer data-project="project_id_here" src="https://cdn.jsdelivr.net/gh/litlyx/litlyx-js/browser/litlyx.js"></script> <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 already tracks 10 KPIs such as `Page visits`, `Browsers`, `Devices`, `OS`, `Real-Time Online Users`, `Unique Session`, `Countries`, `Average Session Time`. 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 # All Javascript Runtimes
@@ -49,7 +49,7 @@ You can install Litlyx using `npm`, `yarn`, or `pnpm`:
npm i litlyx-js npm i litlyx-js
``` ```
Litlyx natively supports all JS/TS frameworks. You can use Litlyx in all WordPress Websites by injecting JS code using a plug-in. Litlyx work in serverless enviroments with Cloud (or Edge) Functions. 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.
<p align="center"> <p align="center">
<img src="assets/techs.png" /> <img src="assets/techs.png" />
@@ -69,17 +69,17 @@ Once imported, you need to initialize Litlyx:
Lit.init('your_project_id'); Lit.init('your_project_id');
``` ```
After initialization, Litlyx will automatically track Analytics such as `Page visits`, `Browsers`, `Devices`, `OS`, `Real-Time Online Users`, `Unique Session`, `Countries`, `Average Session Time`. 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 # Custom Events
With Litlyx, you can create your own events to track in your project. You aren't just limited to the built-in KPIs. With Litlyx, you can create your own events to track in your project.
```js ```js
Lit.event('click_on_buy_item'); Lit.event('click_on_buy_item');
``` ```
If you want more dept tracking, you can use the `metadata` field, like this: If you want more specific tracking, you can use the `metadata` field, like this:
```js ```js
Lit.event('click_on_buy_item', { Lit.event('click_on_buy_item', {
@@ -90,7 +90,7 @@ Lit.event('click_on_buy_item', {
}); });
``` ```
You can create your Tailor-Made Experience at ease. Litlyx makes it easy for you to tailor your analytics to your project's needs.
# AI Data-Analyst # AI Data-Analyst
@@ -98,25 +98,24 @@ You can create your Tailor-Made Experience at ease.
<img src="assets/agent.png" width="180px"/> <img src="assets/agent.png" width="180px"/>
</p> </p>
Lit can compare data, query specific metadata, visualize charts, and much more just by having a simple `conversation` with him. 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 # Self-Hosting with Docker
First thing first **Fork** this repository. To self-host the Litlyx dashboard, first **fork** this repository.
Then run the following command: Then run the following command:
```bash ```bash
docker-compose build docker-compose build
``` ```
then, after the build finish, run: after the build finishes, run:
```bash ```bash
docker-compose up docker-compose up
``` ```
on your localhost you will see your own instance of the Litlyx Dashboard. at localhost:3000 you will see your own instance of the Litlyx Dashboard.
# Official Docs # Official Docs
@@ -124,11 +123,11 @@ For more info read our [documentation](https://docs.litlyx.com). (will be improv
# Join Discord # Join Discord
If you need more information, help, or want to provide general feedback, feel free to join us on[Discord](https://discord.gg/9cQykjsmWX) If you need more information, help, or want to provide general feedback, feel free to join us on the Litlyx [Discord](https://discord.gg/9cQykjsmWX)
# Contributors # Contributors
Every kind of contribution is accepted in this stage of the project. In the future we will onboard you better. Every kind of contribution is accepted in this stage of the project. In the future we will improve the contributor onboarding process.
### Thank you! ### Thank you!
<a href="https://github.com/litlyx/litlyx/graphs/contributors"> <a href="https://github.com/litlyx/litlyx/graphs/contributors">