mirror of
https://github.com/Litlyx/litlyx
synced 2025-12-10 07:48:37 +01:00
142 lines
3.8 KiB
Markdown
142 lines
3.8 KiB
Markdown
|
|
<p align="center">
|
|
<img src="assets/claim.png"/>
|
|
</p>
|
|
|
|
<h4 align="center">
|
|
🌐 <a href="https://litlyx.com">Website</a> 📚 <a href="https://docs.litlyx.com">Docs</a> 👾 <a href="https://discord.gg/9cQykjsmWX">Join Discord</a> 🔥 <a href="https://dashboard.litlyx.com">Start for free!</a>
|
|
</h4>
|
|
|
|
#
|
|
<p align="center">
|
|
The easiest, developer-centric analytics tool.<br>
|
|
Litlyxis an open-source, self-hostable analytics solution for modern framework. Setup takes less than 30 seconds!
|
|
</p>
|
|
|
|
#
|
|
|
|
<br />
|
|
|
|
<p align="center">
|
|
<img src="assets/dashboard-clip.png"/>
|
|
</p>
|
|
|
|
#
|
|
|
|
## Pre-Requisites on Cloud Version
|
|
|
|
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
|
|
|
|
```html
|
|
<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`:
|
|
|
|
```sh
|
|
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.
|
|
|
|
<p align="center">
|
|
<img src="assets/tech.png" />
|
|
</p>
|
|
|
|
# Import
|
|
|
|
Import litlyx-js library into your code:
|
|
|
|
```js
|
|
import { Lit } from 'litlyx-js';
|
|
```
|
|
|
|
Once imported, you need to initialize Litlyx:
|
|
|
|
```js
|
|
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.
|
|
|
|
```js
|
|
Lit.event('click_on_buy_item');
|
|
```
|
|
|
|
If you want more specific tracking, you can use the `metadata` field, like this:
|
|
|
|
```js
|
|
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.
|
|
|
|
|
|
# Fire Your First Event with cURL
|
|
|
|
Want to quickly see how Litlyx works with events? Use the cURL command below to send a test event. Just replace the `project_id` with your actual project ID in your terminal.
|
|
|
|
```bash
|
|
curl -X POST "https://broker.litlyx.com/event" \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"pid": "project_id",
|
|
"name": "testEvent1",
|
|
"metadata": "{\"test\": \"something\"}",
|
|
"website": "something",
|
|
"userAgent": "something"
|
|
}'
|
|
```
|
|
|
|
# Self-Hosting with Docker
|
|
|
|
To self-host the Litlyx dashboard, first **fork** this repository.
|
|
|
|
Then run the following command:
|
|
```bash
|
|
docker-compose build
|
|
```
|
|
|
|
after the build finishes, run:
|
|
```bash
|
|
docker-compose up
|
|
```
|
|
|
|
at localhost:3000 you will see your own instance of the Litlyx Dashboard.
|
|
|
|
# Official Docs
|
|
|
|
For more info read our [documentation](https://docs.litlyx.com). (will be improved in the near future using Mintlify!)
|
|
|
|
# Join Discord
|
|
|
|
If you need more information, interact with us or the community, help, or want to provide feedbacks, feel free to join us on the Litlyx [Discord](https://discord.gg/9cQykjsmWX)
|
|
|
|
# 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!
|
|
<a href="https://github.com/litlyx/litlyx/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=litlyx/litlyx" />
|
|
</a>
|
|
|
|
# License
|
|
|
|
Litlyx is licensed under the [Apache 2.0](/LICENSE) license.
|