Merge branch 'umami-software:master' into master

dorfjungs · Oct 2, 2024 · 029a7f2 · 029a7f2
2 parents a2acbd6 + 1b6429f
commit 029a7f2
Show file tree

Hide file tree

Showing 1,062 changed files with 54,733 additions and 15,326 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,15 +2,9 @@
   "env": {
     "browser": true,
     "es2020": true,
-    "node": true
+    "node": true,
+    "jest": true
   },
-  "extends": [
-    "eslint:recommended",
-    "plugin:prettier/recommended",
-    "plugin:import/recommended",
-    "plugin:@typescript-eslint/recommended",
-    "next"
-  ],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaFeatures": {
@@ -19,29 +13,29 @@
     "ecmaVersion": 11,
     "sourceType": "module"
   },
-  "plugins": ["@typescript-eslint", "prettier"],
   "settings": {
     "import/resolver": {
-      "alias": {
-        "map": [
-          ["assets", "./src/assets"],
-          ["components", "./src/components"],
-          ["db", "./db"],
-          ["hooks", "./src/components/hooks"],
-          ["lang", "./src/lang"],
-          ["lib", "./src/lib"],
-          ["public", "./public"],
-          ["queries", "./src/queries"],
-          ["store", "./src/store"],
-          ["styles", "./src/styles"]
-        ],
-        "extensions": [".ts", ".tsx", ".js", ".jsx", ".json"]
+      "node": {
+        "moduleDirectory": ["node_modules", "src/"]
       }
     }
   },
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "eslint:recommended",
+    "plugin:prettier/recommended",
+    "plugin:import/errors",
+    "plugin:import/typescript",
+    "plugin:css-modules/recommended",
+    "plugin:cypress/recommended",
+    "prettier",
+    "next"
+  ],
+  "plugins": ["@typescript-eslint", "prettier", "promise", "css-modules", "cypress"],
   "rules": {
     "no-console": "error",
     "react/display-name": "off",
+    "react-hooks/exhaustive-deps": "off",
     "react/react-in-jsx-scope": "off",
     "react/prop-types": "off",
     "import/no-anonymous-default-export": "off",

diff --git a/.github/ISSUE_TEMPLATE/1.bug_report.yml b/.github/ISSUE_TEMPLATE/1.bug_report.yml
@@ -1,4 +1,4 @@
-name: "🐛 Bug Report"
+name: '🐛 Bug Report'
 description: Create a bug report for Umami.
 body:
   - type: textarea
@@ -22,11 +22,15 @@ body:
       label: Relevant log output
       description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
       render: shell
+  - type: input
+    attributes:
+      label: Which Umami version are you using? (if relevant)
+      description: 'For example: Chrome, Edge, Firefox, etc'
   - type: input
     attributes:
       label: Which browser are you using? (if relevant)
       description: 'For example: Chrome, Edge, Firefox, etc'
   - type: input
     attributes:
       label: How are you deploying your application? (if relevant)
-      description: 'For example: Vercel, Railway, Docker, etc'
+      description: 'For example: Vercel, Railway, Docker, etc'
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -16,7 +16,9 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Set env
-        run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+        run: |
+          echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+          echo "NOW=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
 
       - uses: mr-smithers-excellent/docker-build-push@v6
         name: Build & push Docker image to ghcr.io for ${{ matrix.db-type }}
@@ -30,6 +32,7 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
+
       - uses: mr-smithers-excellent/docker-build-push@v6
         name: Build & push Docker image to docker.io for ${{ matrix.db-type }}
         with:

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,20 +16,21 @@ jobs:
     strategy:
       matrix:
         include:
-        - node-version: 18.x
+        - node-version: 18.17
           db-type: postgresql
-        - node-version: 18.x
+        - node-version: 18.17
           db-type: mysql
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-        cache: 'npm'
+        cache: 'yarn'
       env:
         DATABASE_TYPE: ${{ matrix.db-type }}
     - run: npm install --global yarn
-    - run: yarn install --frozen-lockfile
+    - run: yarn install
+    - run: yarn test
     - run: yarn build
diff --git a/.gitignore b/.gitignore
@@ -22,6 +22,7 @@ node_modules
 # misc
 .DS_Store
 .idea
+.yarn
 *.iml
 *.log
 .vscode
@@ -35,6 +36,7 @@ yarn-error.log*
 # local env files
 .env
 .env.*
+*.env.*
 
 *.dev.yml
 
diff --git a/.stylelintrc.json b/.stylelintrc.json
@@ -5,13 +5,7 @@
     "stylelint-config-prettier"
   ],
   "rules": {
-    "no-descending-specificity": null,
-    "selector-pseudo-class-no-unknown": [
-      true,
-      {
-        "ignorePseudoClasses": ["global", "horizontal", "vertical"]
-      }
-    ]
+    "no-descending-specificity": null
   },
   "ignoreFiles": ["**/*.js", "**/*.md"]
 }
diff --git a/Dockerfile b/Dockerfile
@@ -37,7 +37,7 @@ RUN adduser --system --uid 1001 nextjs
 
 RUN set -x \
     && apk add --no-cache curl \
-    && yarn add npm-run-all dotenv prisma semver
+    && yarn add npm-run-all dotenv semver prisma@5.17.0
 
 # You only need to copy next.config.js if you are NOT using the default configuration
 COPY --from=builder /app/next.config.js .

diff --git a/README.md b/README.md
@@ -1,69 +1,93 @@
-# umami
+<p align="center">
+  <img src="https://umami.is/images/umami-logo.png" alt="Umami Logo" width="100">
+</p>
 
-Umami is a simple, fast, privacy-focused alternative to Google Analytics.
+<h1 align="center">Umami</h1>
 
-## Getting started
+<p align="center">
+  <i>Umami is a simple, fast, privacy-focused alternative to Google Analytics.</i>
+</p>
 
-A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)
+<p align="center">
+  <a href="https://github.com/umami-software/umami/releases">
+    <img src="https://img.shields.io/github/release/umami-software/umami.svg" alt="GitHub Release" />
+  </a>
+  <a href="https://github.com/umami-software/umami/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/umami-software/umami.svg" alt="MIT License" />
+  </a>
+  <a href="https://github.com/umami-software/umami/actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml" alt="Build Status" />
+  </a>
+  <a href="https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is" style="text-decoration: none;">
+    <img src="https://img.shields.io/badge/Try%20Demo%20Now-Click%20Here-brightgreen" alt="Umami Demo" />
+  </a>
+</p>
 
-## Installing from source
+---
+
+## 🚀 Getting Started
+
+A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/).
+
+---
+
+## 🛠 Installing from Source
 
 ### Requirements
 
 - A server with Node.js version 16.13 or newer
-- A database. Umami supports [MySQL](https://www.mysql.com/) and [Postgresql](https://www.postgresql.org/) databases.
+- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases.
 
 ### Install Yarn
 
-```
+```bash
 npm install -g yarn
 ```
 
-### Get the source code and install packages
+### Get the Source Code and Install Packages
 
-```
+```bash
 git clone https://github.com/umami-software/umami.git
 cd umami
 yarn install
 ```
 
-### Configure umami
+### Configure Umami
 
-Create an `.env` file with the following
+Create an `.env` file with the following:
 
-```
+```bash
 DATABASE_URL=connection-url
 ```
 
-The connection url is in the following format:
+The connection URL format:
 
-```
+```bash
 postgresql://username:mypassword@localhost:5432/mydb
-
 mysql://username:mypassword@localhost:3306/mydb
 ```
 
-### Build the application
+### Build the Application
 
 ```bash
 yarn build
 ```
 
-The build step will also create tables in your database if you ae installing for the first time. It will also create a login user with username **admin** and password **umami**.
+*The build step will create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**.*
 
-### Start the application
+### Start the Application
 
 ```bash
 yarn start
 ```
 
-By default this will launch the application on `http://localhost:3000`. You will need to either
-[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
-or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.
+*By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.*
+
+---
 
-## Installing with Docker
+## 🐳 Installing with Docker
 
-To build the umami container and start up a Postgres database, run:
+To build the Umami container and start up a Postgres database, run:
 
 ```bash
 docker compose up -d
@@ -72,16 +96,18 @@ docker compose up -d
 Alternatively, to pull just the Umami Docker image with PostgreSQL support:
 
 ```bash
-docker pull ghcr.io/umami-software/umami:postgresql-latest
+docker pull docker.umami.is/umami-software/umami:postgresql-latest
 ```
 
 Or with MySQL support:
 
 ```bash
-docker pull ghcr.io/umami-software/umami:mysql-latest
+docker pull docker.umami.is/umami-software/umami:mysql-latest
 ```
 
-## Getting updates
+---
+
+## 🔄 Getting Updates
 
 To get the latest features, simply do a pull, install any new dependencies, and rebuild:
 
@@ -98,6 +124,36 @@ docker compose pull
 docker compose up --force-recreate
 ```
 
-## License
-
-MIT
+---
+
+## 🛟 Support
+
+<p align="center">
+  <a href="https://github.com/umami-software/umami">
+    <img src="https://img.shields.io/badge/GitHub--blue?style=social&logo=github" alt="GitHub" />
+  </a>
+  <a href="https://twitter.com/umami_software">
+    <img src="https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter" alt="Twitter" />
+  </a>
+  <a href="https://linkedin.com/company/umami-software">
+    <img src="https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin" alt="LinkedIn" />
+  </a>
+  <a href="https://umami.is/discord">
+    <img src="https://img.shields.io/badge/Discord--blue?style=social&logo=discord" alt="Discord" />
+  </a>
+</p>
+
+[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg
+[releases-url]: https://github.com/umami-software/umami/releases
+[license-shield]: https://img.shields.io/github/license/umami-software/umami.svg
+[license-url]: https://github.com/umami-software/umami/blob/master/LICENSE
+[build-shield]: https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml
+[build-url]: https://github.com/umami-software/umami/actions
+[github-shield]: https://img.shields.io/badge/GitHub--blue?style=social&logo=github
+[github-url]: https://github.com/umami-software/umami
+[twitter-shield]: https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter
+[twitter-url]: https://twitter.com/umami_software
+[linkedin-shield]: https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin
+[linkedin-url]: https://linkedin.com/company/umami-software
+[discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord
+[discord-url]: https://discord.com/invite/4dz4zcXYrQ
diff --git a/cypress.config.ts b/cypress.config.ts
@@ -0,0 +1,12 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {
+    baseUrl: 'http://localhost:3000',
+  },
+  // default username / password on init
+  env: {
+    umami_user: 'admin',
+    umami_password: 'umami',
+  },
+});