m/umami
1
0
Fork 0
mirror of https://github.com/kremalicious/umami.git synced 2025-02-14 21:10:34 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
SHUBHAM SHARMA 2024-05-25 20:02:00 +05:30 committed by GitHub
parent 65b1992c46
commit fdf28920e6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -2,27 +2,31 @@
<img src="https://github.com/shubhusion/umami/blob/master/src/assets/logo-white.svg" alt="Umami Logo" width="100"> <img src="https://github.com/shubhusion/umami/blob/master/src/assets/logo-white.svg" alt="Umami Logo" width="100">
</p> </p>
# 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] [![GitHub Release][release-shield]][releases-url] [![MIT License][license-shield]][license-url] [![Build Status][build-shield]][build-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: 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. 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/) A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)
## Installing from Source ---
## 🛠 Installing from Source
### Requirements ### 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. 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:
@ -94,7 +100,9 @@ Or with MySQL support:
docker pull docker.umami.is/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: 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 docker compose up --force-recreate
``` ```
## Contact ---
[![GitHub][github-shield]][github-url] ## 📞 Contact
[![Twitter][twitter-shield]][twitter-url]
[![LinkedIn][linkedin-shield]][linkedin-url] [![GitHub][github-shield]][github-url] [![Twitter][twitter-shield]][twitter-url] [![LinkedIn][linkedin-shield]][linkedin-url] [![Discord][discord-shield]][discord-url]
[![Discord][discord-shield]][discord-url]
[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg [release-shield]: https://img.shields.io/github/release/umami-software/umami.svg
[releases-url]: https://github.com/umami-software/umami/releases [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 [linkedin-url]: https://linkedin.com/company/umami-software
[discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord [discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord
[discord-url]: https://discord.com/invite/4dz4zcXYrQ [discord-url]: https://discord.com/invite/4dz4zcXYrQ
---