Merge branch 'Litlyx:main' into main

Author: nerdy-tech-com-gitub

.dockerignore

@@ -1,51 +1,26 @@
+shared/node_modules
+shared/.output
+
+scripts/node_modules
 
-# Broker
-broker/node_modules
-broker/scripts/start_dev.js
-broker/ecosystem.config.cjs
-broker/ecosystem.config.example.cjs
-broker/Dockerfile
-broker/.gitignore
-broker/dist
+lyx-ui/node_modules
+lyx-ui/.nuxt
+lyx-ui/.output
 
-# Producer
 producer/node_modules
 producer/scripts/start_dev.js
 producer/ecosystem.config.cjs
-producer/ecosystem.config.example.cjs
-producer/Dockerfile
-producer/.gitignore
-producer/dist
 
-# Dashboard
+consumer/node_modules
+consumer/scripts/start_dev.js
+consumer/ecosystem.config.cjs
+
 dashboard/node_modules
 dashboard/.nuxt
 dashboard/.output
+dashboard/explains
 dashboard/tests
-dashboard/.env.example
 dashboard/.env
-dashboard/.gitignore
+dashboard/winston-*.ndjson
 dashboard/ecosystem.config.cjs
-dashboard/out.pdf
-dashboard/timeline.report.txt
-dashboard/Dockerfile
-dashboard/vitest.config.ts
-dashboard/vitest.setup.ts
-
-# Shared
-shared/node_modules
-shared/.gitignore
 
-# Others
-docs/*
-landing/*
-docker/*
-dev/*
-assets/*
-CODE_OF_CONDUCT.md
-LICENSE
-readme.md
-SECURITY.md
-steps
-docker-compose.yml
-docker-compose.admin.yml

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "files.exclude": {
+        "**/node_modules": true
+    }
+}

Dockerfile

@@ -0,0 +1,30 @@
+FROM node:21-alpine as base
+
+FROM base as build
+
+RUN npm i -g pnpm
+RUN npm i -g pm2
+
+# COPY --link dashboard/package.json dashboard/pnpm-lock.yaml ./
+# RUN npm install --production=false
+
+WORKDIR /home/app
+
+COPY --link dashboard ./dashboard
+COPY --link lyx-ui ./lyx-ui
+COPY --link consumer ./consumer
+COPY --link producer ./producer
+COPY --link shared ./shared
+
+WORKDIR /home/app/producer
+RUN pnpm install
+
+WORKDIR /home/app/consumer
+RUN pnpm install
+
+WORKDIR /home/app/dashboard
+RUN pnpm install
+RUN pnpm run dev
+
+
+# CMD [ "node", "/home/app/.output/server/index.mjs" ]

README.md

@@ -4,13 +4,13 @@
 </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> 
+🌐 <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">Try Litlyx Cloud. It's 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!
+  The freshest, developer-friendly analytics tool.<br>
+  Litlyx is an open-source, self-hostable analytics solution for modern frameworks. Setup takes less than 30 seconds!
 </p>
 
 #
@@ -23,27 +23,27 @@
 
 #
 
-## Pre-Requisites on Cloud Version
+## Get Started on our 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>
+<script defer data-project="your_project_id" 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`.
+Importing Litlyx with a direct script instantly starts tracking `Page visits`, `Browsers`, `Devices`, `Operating Systems`, `Bouncing Rate`, `Real-Time Online Users`, `Unique Sessions`, `Countries`, and `Average Session Time`.
 
 # All Javascript Runtimes
 
-You can install Litlyx using `npm`, `yarn`, or `pnpm`:
+You can install Litlyx using `npm`, `pnpm`, `yarn` or any modern package managers:
 
 ```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.
+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 environments with Cloud (or Edge) Functions.
 
 <p align="center">
   <img src="assets/tech.png" />
@@ -65,7 +65,7 @@ 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
+# Track 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.
 
@@ -80,6 +80,7 @@ Lit.event('click_on_buy_item', {
   metadata: {
     'product-name': 'Coca-Cola',
     'price': 1.50,
+    'currency': 'EUR'
   }
 });
 ```
@@ -119,6 +120,19 @@ docker-compose up
 
 at localhost:3000 you will see your own instance of the Litlyx Dashboard.
 
+## Forward data to your local instance with script tag
+
+To forward your data on your self-hosted instance, you need to set up the following variables: add your `data-host`, add your `data-port`, and add your `data-secure`, setting it to true if it is HTTPS, and false if it is HTTP.
+
+```html
+<script defer data-project="your_project_id" 
+        data-host="your-host-name" 
+        data-port="your-port" 
+        data-secure="true/false"
+        src="https://cdn.jsdelivr.net/gh/litlyx/litlyx-js/browser/litlyx.js">
+</script>
+```
+
 # Official Docs
 
 For more info read our [documentation](https://docs.litlyx.com). (will be improved in the near future using Mintlify!)