Merge pull request #31 from wpgaurav/main

Compress file sizes

.gitignore

@@ -5,6 +5,7 @@ docker
 dev
 docker-compose.admin.yml
 full_reload.sh
+build-all.sh
 tmp
 ecosystem.config.js
 todo

README.md

@@ -4,13 +4,14 @@
 </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">Try Litlyx Cloud. It's Free.</a> 
+📚 <a href="https://docs.litlyx.com">Docs</a> 👾 <a href="https://discord.gg/9cQykjsmWX">Join Discord</a> 🌐 <a href="https://litlyx.com">Website</a>  🔥 <a href="https://dashboard.litlyx.com">Try Litlyx Cloud. It's Free forever.</a> 
 </h4>
 
 #
 <p align="center">
-  The freshest, developer-friendly analytics tool.<br>
+  Litlys is a modern, developer-friendly, cookie-free analytics tool.<br>
-  Litlyx is an open-source, self-hostable analytics solution for modern frameworks. Setup takes less than 30 seconds!
+  Setup takes less than 30 seconds! Completely self-hostable with docker.<br>
+  Alternative to Google Analytics, Matomo, Umami, Plausible & Simple Analytics.
 </p>
 
 #
@@ -25,7 +26,7 @@
 
 ## 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.
+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.
 
 ## Universal Installation
 
@@ -33,25 +34,25 @@ Sign-up on [Litlyx.com](https://dashboard.litlyx.com) and create a project. Then
 <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 `Page visits`, `Browsers`, `Devices`, `Operating Systems`, `Bouncing Rate`, `Real-Time Online Users`, `Unique Sessions`, `Countries`, and `Average Session Time`.
+Importing Litlyx with a direct script instantly starts tracking `Visits`, `Top Pages`, `Bouncing Rate`,  `Real-Time Online Users`, `Unique Visitors`, `Countries`, and `Average Session Duration`.
 
 # All Javascript Runtimes
 
-You can install Litlyx using `npm`, `pnpm`, `yarn` or any modern package managers:
+You can install Litlyx using `npm`, `pnpm` 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 environments 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 third party plug-in. 
 
 <p align="center">
   <img src="assets/tech.png" />
 </p>
 
-# Import
+# Import using a package manager
 
-Import litlyx-js library into your code:
+First, Import litlyx-js library into your code:
 
 ```js
 import { Lit } from 'litlyx-js';
@@ -63,9 +64,9 @@ 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`.
+After initialization, Litlyx will automatically track web analytics such as `Page visits`, `Real-Time Online Users`, `Unique Vistors`, and many more.
 
-# Track Custom Events
+# Track Custom Events (Actions)
 
 You aren't just limited to the built-in KPIs. With Litlyx, you can create your own events to track in your project.
 
@@ -104,11 +105,9 @@ curl -X POST "https://broker.litlyx.com/event" \
   }'
 ```
 
-# Self-Hosting with Docker
+# Self-hosting with docker
 
-To self-host the Litlyx dashboard, first **fork** this repository.
+To self-host the Litlyx dashboard, first **clone** this repository. (Litlyx's Docker images are hosted on DockerHub). 
-
-You can find our Docker images on DockerHub for more.
 
 Then run the following command:
 ```bash
@@ -117,9 +116,9 @@ 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
+## Forward data to your self-hosted 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.
+To forward your data on your self-hosted instance, you need to set up the following variables: `data-host`, `data-port`,  `data-secure`(`true` if it is HTTPS or `false` if it is HTTP).
 
 ```html
 <script defer data-project="your_project_id" 
@@ -130,17 +129,23 @@ To forward your data on your self-hosted instance, you need to set up the follow
 </script>
 ```
 
-# Official Docs
+# Read our docs
 
-For more info read our [documentation](https://docs.litlyx.com). (will be improved in the near future using Mintlify!)
+For more info on how to use litlyx read our [documentation](https://docs.litlyx.com). 
 
-# 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)
+# Stay updated with our roadmap
 
-# Contributors
+To keep track on what we are cooking behind the scene we have a public [Roadmap](https://litlyx.com/roadmap) for you to check. 
 
-Every kind of contribution is accepted in this stage of the project. In the future we will improve the contributor onboarding process.
+
+# Join discord
+
+If you need more information, want to interact with us or the community, need help, or have feedback to share, feel free to join us on Litlyx's [Discord](https://discord.gg/9cQykjsmWX) channel.
+
+# Contribution
+
+If you want to contribute to Litlyx's development, reach out to us on [Discord](https://discord.gg/9cQykjsmWX) in our `#contribution` channel.
 
 ### Thank you!
 <a href="https://github.com/litlyx/litlyx/graphs/contributors">

consumer/Dockerfile

@@ -5,24 +5,13 @@ RUN npm i -g pnpm
 
 WORKDIR /home/app
 
-COPY --link ./package.json ./tsconfig.json ./pnpm-lock.yaml ./
-COPY --link ./scripts/package.json ./scripts/pnpm-lock.yaml ./scripts/
 COPY --link ./consumer/package.json ./consumer/pnpm-lock.yaml ./consumer/
 
-RUN pnpm install
-RUN pnpm install --filter consumer
-
-WORKDIR /home/app/scripts
-RUN pnpm install
-
-WORKDIR /home/app
-
-COPY --link ../scripts ./scripts
-COPY --link ../shared ./shared
-COPY --link ../consumer ./consumer
-
 WORKDIR /home/app/consumer
+RUN pnpm install
+
+COPY --link ../consumer ./
 
 RUN pnpm run build
 
-CMD ["node", "/home/app/consumer/dist/consumer/src/index.js"]
+CMD ["node", "/home/app/consumer/dist/index.js"]

dashboard/Dockerfile

@@ -7,20 +7,14 @@ RUN npm i -g pnpm
 
 WORKDIR /home/app
 
-COPY --link ./package.json ./tsconfig.json ./pnpm-lock.yaml ./
 COPY --link ./dashboard/package.json ./dashboard/pnpm-lock.yaml ./dashboard/
 
-RUN pnpm install
-RUN pnpm install --filter dashboard
-
-WORKDIR /home/app
-
-COPY --link ./dashboard ./dashboard
-COPY --link ./shared ./shared
-
 WORKDIR /home/app/dashboard
+RUN pnpm install
 
-RUN pnpm run build
+COPY --link ./dashboard ./
+
+RUN pnpm run build:compose
 
 FROM node:21-alpine AS production
 

dashboard/nuxt.config.ts

@@ -55,7 +55,7 @@ export default defineNuxtConfig({
     STRIPE_SECRET_TEST: process.env.STRIPE_SECRET_TEST,
     STRIPE_WH_SECRET_TEST: process.env.STRIPE_WH_SECRET_TEST,
     NOAUTH_USER_EMAIL: process.env.NOAUTH_USER_EMAIL,
-    NOAUTH_USER_NAME: process.env.NOAUTH_USER_NAME,
+    NOAUTH_USER_PASS: process.env.NOAUTH_USER_PASS,
     MODE: process.env.MODE || 'NONE',
     SELFHOSTED: process.env.SELFHOSTED || 'FALSE',
     public: {

dashboard/package.json

@@ -5,8 +5,10 @@
   "scripts": {
     "build": "npm run workspace:shared && nuxt build --dotenv .env.testmode",
     "build:prod": "npm run workspace:shared && nuxt build --dotenv .env.prod",
+    "build:compose": "nuxt build",
     "dev": "npm run workspace:shared && nuxt dev --dotenv .env.testmode",
     "dev:prod": "npm run workspace:shared && nuxi dev --dotenv .env.prod",
+    "dev:docker": "npm run workspace:shared && nuxi dev --dotenv .env.docker",
     "generate": "nuxt generate",
     "preview": "nuxt preview",
     "postinstall": "nuxt prepare",

dashboard/pages/login.vue

@@ -13,32 +13,6 @@ const useCodeClientWrapper = isNoAuth.value === false ?
         return { isReady: false, login: () => { } }
     }
 
-async function loginWithoutAuth() {
-    try {
-        const result = await $fetch('/api/auth/no_auth');
-        if (result.error) return alert('Error during login, please try again');
-
-        setToken(result.access_token);
-
-        const user = await $fetch<any>('/api/user/me', { headers: { 'Authorization': 'Bearer ' + token.value } })
-        const loggedUser = useLoggedUser();
-        loggedUser.user = user;
-
-        console.log('LOGIN DONE - USER', loggedUser.user);
-
-        const isFirstTime = await $fetch<boolean>('/api/user/is_first_time', { headers: { 'Authorization': 'Bearer ' + token.value } })
-
-        if (isFirstTime === true) {
-            router.push('/project_creation?just_logged=true');
-        } else {
-            router.push('/?just_logged=true');
-        }
-
-    } catch (ex: any) {
-        alert('Error during login.' + ex.message);
-    }
-}
-
 const { isReady, login } = useCodeClientWrapper({ onSuccess: handleOnSuccess, onError: handleOnError, });
 
 const router = useRouter();
@@ -121,6 +95,39 @@ function goBackToEmailLogin() {
     password.value = '';
 }
 
+async function signInSelfhosted() {
+    try {
+        const result = await $fetch(`/api/auth/no_auth`, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({ email: email.value, password: password.value })
+        });
+        if (result.error) {
+            if (result.errorMessage) return alert(result.errorMessage);
+            return alert('Error during login, please try again');
+        }
+
+        setToken(result.access_token);
+
+        const user = await $fetch<any>('/api/user/me', { headers: { 'Authorization': 'Bearer ' + token.value } })
+        const loggedUser = useLoggedUser();
+        loggedUser.user = user;
+
+        console.log('LOGIN DONE - USER', loggedUser.user);
+
+        const isFirstTime = await $fetch<boolean>('/api/user/is_first_time', { headers: { 'Authorization': 'Bearer ' + token.value } })
+
+        if (isFirstTime === true) {
+            router.push('/project_creation?just_logged=true');
+        } else {
+            router.push('/?just_logged=true');
+        }
+
+    } catch (ex: any) {
+        alert('Error during login.' + ex.message);
+    }
+}
+
 async function signInWithCredentials() {
 
     try {
@@ -176,7 +183,8 @@ async function signInWithCredentials() {
                     Sign in
                 </div>
 
-                <div class="text-lyx-lightmode-text/80 dark:text-lyx-text/80 text-[1.2rem] font-light text-center w-[70%] poppins mt-2">
+                <div
+                    class="text-lyx-lightmode-text/80 dark:text-lyx-text/80 text-[1.2rem] font-light text-center w-[70%] poppins mt-2">
                     Track web analytics and custom events
                     with extreme simplicity in under 30 sec.
                     <br>
@@ -217,7 +225,8 @@ async function signInWithCredentials() {
 
                     </div>
 
-                    <div v-if="!isNoAuth && !isEmailLogin" class="flex flex-col text-lyx-lightmode-text dark:text-lyx-text gap-2">
+                    <div v-if="!isNoAuth && !isEmailLogin"
+                        class="flex flex-col text-lyx-lightmode-text dark:text-lyx-text gap-2">
 
                         <div @click="login"
                             class="hover:bg-lyx-primary bg-white dark:bg-transparent cursor-pointer flex text-[1.3rem] gap-4 items-center border-[1px] border-gray-400 rounded-lg px-8 py-3 relative z-[2]">
@@ -247,17 +256,30 @@ async function signInWithCredentials() {
 
                     </div>
 
+
+
                     <div v-if="isNoAuth" @click="loginWithoutAuth"
-                        class="hover:bg-accent cursor-pointer flex text-[1.3rem] gap-4 items-center border-[1px] border-gray-400 rounded-lg px-8 py-3 relative z-[2]">
+                        class="flex text-[1.3rem] flex-col gap-4 items-center px-8 py-3 relative z-[2]">
-                        <div class="flex items-center">
+                        <div class="flex flex-col gap-4 z-[100] w-[20vw] min-w-[20rem]">
-                            <i class="far fa-crown"></i>
+                            <LyxUiInput class="px-3 py-2" placeholder="Email" v-model="email"></LyxUiInput>
+                            <LyxUiInput class="px-3 py-2" placeholder="Password" v-model="password" type="password">
+                            </LyxUiInput>
                         </div>
-                        Continue as Admin
+                        <div class="flex justify-center mt-4 z-[100]">
+                            <LyxUiButton @click="signInSelfhosted()" class="text-center" type="primary">
+                                Sign in
+                            </LyxUiButton>
                         </div>
+                    </div>
+
+
+
+
 
                 </div>
 
-                <div class="text-[.9rem] poppins mt-20 text-lyx-lightmode-text-dark dark:text-lyx-text-dark text-center relative z-[2]">
+                <div
+                    class="text-[.9rem] poppins mt-20 text-lyx-lightmode-text-dark dark:text-lyx-text-dark text-center relative z-[2]">
                     By continuing you are accepting
                     <br>
                     our

dashboard/server/api/auth/no_auth.ts

@@ -2,7 +2,7 @@
 import { createUserJwt } from '~/server/AuthManager';
 import { UserModel } from '@schema/UserSchema';
 
-const { NOAUTH_USER_EMAIL, NOAUTH_USER_NAME, public: publicRuntime } = useRuntimeConfig();
+const { NOAUTH_USER_EMAIL, NOAUTH_USER_PASS, public: publicRuntime } = useRuntimeConfig();
 
 const noAuthMode = publicRuntime.AUTH_MODE == 'NO_AUTH';
 
@@ -18,11 +18,15 @@ export default defineEventHandler(async event => {
         return { error: true, access_token: '' }
     }
 
-    if (!NOAUTH_USER_NAME) {
+    if (!NOAUTH_USER_PASS) {
-        console.error('NOAUTH_USER_NAME is required in NO_AUTH mode');
+        console.error('NOAUTH_USER_PASS is required in NO_AUTH mode');
         return { error: true, access_token: '' }
     }
 
+    const body = await readBody(event);
+
+    if (body.email != NOAUTH_USER_EMAIL || body.password != NOAUTH_USER_PASS) return { error: true, access_token: '', errorMessage: 'Username or password invalid' }
+
     const user = await UserModel.findOne({ email: NOAUTH_USER_EMAIL });
 
     if (user) return {
@@ -35,8 +39,8 @@ export default defineEventHandler(async event => {
 
     const newUser = new UserModel({
         email: NOAUTH_USER_EMAIL,
-        given_name: NOAUTH_USER_NAME,
+        given_name: NOAUTH_USER_EMAIL.split('@')[0] || 'NONAME',
-        name: NOAUTH_USER_NAME,
+        name: NOAUTH_USER_EMAIL.split('@')[0] || 'NONAME',
         locale: 'no-auth',
         picture: '',
         created_at: Date.now()

docker-compose.yml

@@ -90,9 +90,9 @@ services:
       # NO_AUTH or GOOGLE
       NUXT_PUBLIC_AUTH_MODE: 'NO_AUTH'
 
-      # Default user created in NO_AUTH mode
+      # Credentials to login in NO_AUTH mode
       NUXT_NOAUTH_USER_EMAIL: 'default@user.com'
-      NUXT_NOAUTH_USER_NAME: "defaultuser"
+      NUXT_NOAUTH_USER_PASS: "litlyx123"
 
       NUXT_SELFHOSTED: 'true'
       NUXT_PUBLIC_SELFHOSTED: 'true'

producer/Dockerfile

@@ -5,24 +5,13 @@ RUN npm i -g pnpm
 
 WORKDIR /home/app
 
-COPY --link ./package.json ./tsconfig.json ./pnpm-lock.yaml ./
-COPY --link ./scripts/package.json ./scripts/pnpm-lock.yaml ./scripts/
 COPY --link ./producer/package.json ./producer/pnpm-lock.yaml ./producer/
 
-RUN pnpm install
-RUN pnpm install --filter producer
-
-WORKDIR /home/app/scripts
-RUN pnpm install
-
-WORKDIR /home/app
-
-COPY --link ../scripts ./scripts
-COPY --link ../shared ./shared
-COPY --link ../producer ./producer
-
 WORKDIR /home/app/producer
+RUN pnpm install
+
+COPY --link ../producer ./
 
 RUN pnpm run build
 
-CMD ["node", "/home/app/producer/dist/producer/src/index.js"]
+CMD ["node", "/home/app/producer/dist/index.js"]

shared_global/pnpm-lock.yaml

@@ -11,9 +11,6 @@ importers:
       '@types/node':
         specifier: ^22.10.10
         version: 22.10.10
-      '@types/redis':
-        specifier: ^4.0.11
-        version: 4.0.11
       date-fns:
         specifier: ^4.1.0
         version: 4.1.0
@@ -64,10 +61,6 @@ packages:
   '@types/node@22.10.10':
     resolution: {integrity: sha512-X47y/mPNzxviAGY5TcYPtYL8JsY3kAq2n8fMmKoRCxq/c4v4pyGNCzM2R6+M5/umG4ZfHuT+sgqDYqWc9rJ6ww==}
 
-  '@types/redis@4.0.11':
-    resolution: {integrity: sha512-bI+gth8La8Wg/QCR1+V1fhrL9+LZUSWfcqpOj2Kc80ZQ4ffbdL173vQd5wovmoV9i071FU9oP2g6etLuEwb6Rg==}
-    deprecated: This is a stub types definition. redis provides its own type definitions, so you do not need this installed.
-
   '@types/webidl-conversions@7.0.3':
     resolution: {integrity: sha512-CiJJvcRtIgzadHCYXw7dqEnMNRjhGZlYK05Mj9OyktqV8uVT8fD2BFOB7S1uwBE3Kj2Z+4UyPmFw/Ixgw/LAlA==}
 
@@ -220,10 +213,6 @@ snapshots:
     dependencies:
       undici-types: 6.20.0
 
-  '@types/redis@4.0.11':
-    dependencies:
-      redis: 4.7.0
-
   '@types/webidl-conversions@7.0.3': {}
 
   '@types/whatwg-url@11.0.5':