From 16e1949d244e58cde1a5bd840af1d43c8b71692e Mon Sep 17 00:00:00 2001 From: shubhusion Date: Fri, 24 May 2024 12:26:46 +0530 Subject: [PATCH 01/14] Create logo-white.svg.svg --- src/assets/logo-white.svg.svg | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/assets/logo-white.svg.svg diff --git a/src/assets/logo-white.svg.svg b/src/assets/logo-white.svg.svg new file mode 100644 index 00000000..12a76d34 --- /dev/null +++ b/src/assets/logo-white.svg.svg @@ -0,0 +1,4 @@ + + + + From 47c4e6fd57d8008ad2441c832f15a3facfc84e40 Mon Sep 17 00:00:00 2001 From: shubhusion Date: Fri, 24 May 2024 12:28:18 +0530 Subject: [PATCH 02/14] modified logo --- src/assets/{logo-white.svg.svg => logo-white.svg} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/assets/{logo-white.svg.svg => logo-white.svg} (100%) diff --git a/src/assets/logo-white.svg.svg b/src/assets/logo-white.svg similarity index 100% rename from src/assets/logo-white.svg.svg rename to src/assets/logo-white.svg From 51f7e187b73097c80558f3cefcf8c3dd0f776bca Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Fri, 24 May 2024 12:40:00 +0530 Subject: [PATCH 03/14] Update README.md --- README.md | 53 ++++++++++++++++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 6d9755d4..9ca0bf8a 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,56 @@ -# umami +

+ Umami Logo +

-Umami is a simple, fast, privacy-focused alternative to Google Analytics. +# Umami -## Getting started +> Umami is a simple, fast, privacy-focused alternative to Google Analytics. + +[![GitHub Release][release-shield]][releases-url] +[![MIT License][license-shield]][license-url] +[![Build Status][build-shield]][build-url] + +## Getting Started A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/) -## Installing from source +## Installing from Source ### Requirements - A server with Node.js version 16.13 or newer -- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [Postgresql](https://www.postgresql.org/) (minimum v12.14) 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 is in the following format: -``` +```bash postgresql://username:mypassword@localhost:5432/mydb - mysql://username:mypassword@localhost:3306/mydb ``` -### Build the application +### Build the Application ```bash yarn build @@ -51,19 +58,17 @@ yarn build The build step will also 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 -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 @@ -81,7 +86,7 @@ Or with MySQL support: 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: @@ -102,3 +107,9 @@ docker compose up --force-recreate MIT +[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 From d46b27409480bc1f3cd8f21786c86894c8c72f5d Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 00:10:11 +0530 Subject: [PATCH 04/14] Update logo-white.svg --- src/assets/logo-white.svg | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/assets/logo-white.svg b/src/assets/logo-white.svg index 12a76d34..b5a46790 100644 --- a/src/assets/logo-white.svg +++ b/src/assets/logo-white.svg @@ -1,4 +1 @@ - - - - + From 754ca24ca5f8e3d632a6837b0b884591b85df729 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 00:13:55 +0530 Subject: [PATCH 05/14] Update logo-white.svg --- src/assets/logo-white.svg | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/assets/logo-white.svg b/src/assets/logo-white.svg index b5a46790..12a76d34 100644 --- a/src/assets/logo-white.svg +++ b/src/assets/logo-white.svg @@ -1 +1,4 @@ - + + + + From 3222033f364853e18c4bfd5ad950a79db83d4906 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 00:18:10 +0530 Subject: [PATCH 06/14] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9ca0bf8a..44874a5e 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,14 @@ [![MIT License][license-shield]][license-url] [![Build Status][build-shield]][build-url] +## Demo + +Explore Umami's features by trying out our demo installation: + +[Umami Demo](https://demo.umami.is/) + +Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server. + ## Getting Started A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/) From db06a0d25665556d67f2481837280a2a90a11a05 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 19:48:58 +0530 Subject: [PATCH 07/14] Update README.md --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 44874a5e..4579b8f4 100644 --- a/README.md +++ b/README.md @@ -110,11 +110,6 @@ To update the Docker image, simply pull the new images and rebuild: docker compose pull docker compose up --force-recreate ``` - -## License - -MIT - [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 From 65b1992c461b10d53b0ed9a9344399815218b865 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 19:56:32 +0530 Subject: [PATCH 08/14] Update README.md --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 4579b8f4..177b977f 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,25 @@ To update the Docker image, simply pull the new images and rebuild: docker compose pull docker compose up --force-recreate ``` + +## Contact + +[![GitHub][github-shield]][github-url] +[![Twitter][twitter-shield]][twitter-url] +[![LinkedIn][linkedin-shield]][linkedin-url] +[![Discord][discord-shield]][discord-url] + [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 From fdf28920e6e53bf1cb22818d891ead0fc8960de8 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 20:02:00 +0530 Subject: [PATCH 09/14] Update README.md --- README.md | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 177b977f..18c5635a 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,31 @@ Umami Logo

-# Umami +# 🌐 Umami -> Umami is a simple, fast, privacy-focused alternative to Google Analytics. +> **Umami** is a simple, fast, privacy-focused alternative to Google Analytics. -[![GitHub Release][release-shield]][releases-url] -[![MIT License][license-shield]][license-url] -[![Build Status][build-shield]][build-url] +[![GitHub Release][release-shield]][releases-url] [![MIT License][license-shield]][license-url] [![Build Status][build-shield]][build-url] -## Demo +--- + +## 🎉 Demo Explore Umami's features by trying out our demo installation: -[Umami Demo](https://demo.umami.is/) +👉 [Umami Demo](https://demo.umami.is/) 👈 Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server. -## Getting Started +--- + +## 🚀 Getting Started A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/) -## Installing from Source +--- + +## 🛠 Installing from Source ### Requirements @@ -74,7 +78,9 @@ 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. -## Installing with Docker +--- + +## 🐳 Installing with Docker To build the Umami container and start up a Postgres database, run: @@ -94,7 +100,9 @@ Or with MySQL support: 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: @@ -111,12 +119,11 @@ docker compose pull docker compose up --force-recreate ``` -## Contact +--- -[![GitHub][github-shield]][github-url] -[![Twitter][twitter-shield]][twitter-url] -[![LinkedIn][linkedin-shield]][linkedin-url] -[![Discord][discord-shield]][discord-url] +## 📞 Contact + +[![GitHub][github-shield]][github-url] [![Twitter][twitter-shield]][twitter-url] [![LinkedIn][linkedin-shield]][linkedin-url] [![Discord][discord-shield]][discord-url] [release-shield]: https://img.shields.io/github/release/umami-software/umami.svg [releases-url]: https://github.com/umami-software/umami/releases @@ -132,3 +139,5 @@ docker compose up --force-recreate [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 + +--- From 9c532f26abb02f70b8f4b30c90e0eebcf6ab6e7f Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 20:07:21 +0530 Subject: [PATCH 10/14] Update README.md --- README.md | 47 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 36 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 18c5635a..8e0df60b 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,25 @@ Umami Logo

-# 🌐 Umami +

🌐 Umami

-> **Umami** is a simple, fast, privacy-focused alternative to Google Analytics. +

Empowering insights. Preserving privacy.

-[![GitHub Release][release-shield]][releases-url] [![MIT License][license-shield]][license-url] [![Build Status][build-shield]][build-url] +

+ Umami is a simple, fast, privacy-focused alternative to Google Analytics. +

+ +

+ + GitHub Release + + + MIT License + + + Build Status + +

--- @@ -16,13 +30,13 @@ Explore Umami's features by trying out our demo installation: 👉 [Umami Demo](https://demo.umami.is/) 👈 -Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server. +*Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server.* --- ## 🚀 Getting Started -A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/) +A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/). --- @@ -55,7 +69,7 @@ Create an `.env` file with the following: DATABASE_URL=connection-url ``` -The connection URL is in the following format: +The connection URL format: ```bash postgresql://username:mypassword@localhost:5432/mydb @@ -68,7 +82,7 @@ mysql://username:mypassword@localhost:3306/mydb yarn build ``` -The build step will also 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**. +*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 @@ -76,7 +90,7 @@ The build step will also create tables in your database if you are installing fo 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.* --- @@ -123,7 +137,20 @@ docker compose up --force-recreate ## 📞 Contact -[![GitHub][github-shield]][github-url] [![Twitter][twitter-shield]][twitter-url] [![LinkedIn][linkedin-shield]][linkedin-url] [![Discord][discord-shield]][discord-url] +

+ + GitHub + + + Twitter + + + LinkedIn + + + Discord + +

[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg [releases-url]: https://github.com/umami-software/umami/releases @@ -139,5 +166,3 @@ docker compose up --force-recreate [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 - ---- From e1de8f30c21903bc0a34926fe90688e618ea89f4 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 20:08:33 +0530 Subject: [PATCH 11/14] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e0df60b..95996c2b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Umami Logo

-

🌐 Umami

+

Umami

Empowering insights. Preserving privacy.

From 46724280ca00a0eca2a4fe86c53f8adee9a7ef2f Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 20:10:17 +0530 Subject: [PATCH 12/14] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 95996c2b..062a9dc0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Explore Umami's features by trying out our demo installation: -👉 [Umami Demo](https://demo.umami.is/) 👈 +👉 [Umami Demo](https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is) 👈 *Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server.* From 2df45f30d08b99477a8b6009c4787352f6266e3d Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 20:10:47 +0530 Subject: [PATCH 13/14] Update README.md --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 062a9dc0..8536af3c 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,6 @@ Explore Umami's features by trying out our demo installation: 👉 [Umami Demo](https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is) 👈 -*Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server.* - --- ## 🚀 Getting Started From 89dcdf703fc01e12647c988b802e825c2e682f27 Mon Sep 17 00:00:00 2001 From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com> Date: Sat, 25 May 2024 20:13:28 +0530 Subject: [PATCH 14/14] Update README.md --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8536af3c..358fa392 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Umami Logo

-

Umami

+

Umami

Empowering insights. Preserving privacy.

@@ -20,18 +20,13 @@ Build Status + + Umami Demo +

--- -## 🎉 Demo - -Explore Umami's features by trying out our demo installation: - -👉 [Umami Demo](https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is) 👈 - ---- - ## 🚀 Getting Started A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/).