Skip to content

Commit

Permalink
Update README (#162)
Browse files Browse the repository at this point in the history
* Add screenshot to readme

* Update the screenshot on the home page

* Update self-hosted example env file

* Add sponsoring section to readme.

* Delete settings.json

* Delete idea residue files
  • Loading branch information
th0th committed Mar 7, 2023
1 parent 2c7edc5 commit 50c330e
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 124 deletions.
5 changes: 1 addition & 4 deletions .idea/jsonSchemas.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

80 changes: 0 additions & 80 deletions .idea/remote-targets.xml

This file was deleted.

14 changes: 0 additions & 14 deletions .idea/runConfigurations/_template__of_Go_Test.xml

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/runConfigurations/debug_rest_api.xml

This file was deleted.

8 changes: 0 additions & 8 deletions .idea/runConfigurations/test_prepare.xml

This file was deleted.

5 changes: 0 additions & 5 deletions .vscode/settings.json

This file was deleted.

20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,25 @@
<h3 align="center">Free as in freedom, privacy-first,<br />regulation-compliant analytics tool.</h3>

<p align="center">
<a href="https://www.gnu.org/licenses/agpl-3.0"><img alt="License: AGPL-3.0" src="https://img.shields.io/github/license/th0th/poeticmetric"></a>
<a href="https://github.com/th0th/poeticmetric/releases/latest"><img src="https://img.shields.io/github/release/th0th/poeticmetric.svg" /></a>
<a href="https://discord.poeticmetric.com"><img alt="Discord" src="https://img.shields.io/discord/866008872506097715" /></a>
<a href="https://www.gnu.org/licenses/agpl-3.0"><img alt="License: AGPL-3.0" src="https://img.shields.io/github/license/th0th/poeticmetric"></a>
<a href="https://github.com/th0th/poeticmetric/releases/latest"><img alt="latest version" src="https://img.shields.io/github/release/th0th/poeticmetric.svg" /></a>
<a href="https://discord.poeticmetric.com"><img alt="Discord" src="https://img.shields.io/discord/866008872506097715" /></a>
</p>

**PoeticMetric** is a privacy-focused, open source, and blazingly fast alternative to Google Analytics. It doesn't use cookies or any other similar technology, and it doesn't collect any personal data. So you don't have to worry about cookie banners, PoeticMetric is totally compliant with data privacy regulations GDPR, CCPA, PECR and KVKK.

PoeticMetric is **privacy-first**, **transparent**, **efficient** and **sustainable**. If you would like to read more about PoeticMetric's vision, you can check out my manifesto: [Building a Better Web: PoeticMetric's Vision](https://www.poeticmetric.com/manifesto).

<br />

<p align="center">
<a href="https://www.poeticmetric.com/s?d=www.poeticmetric.com">
<kbd>
<img width="800" alt="Click here to see a live demo" src="https://user-images.githubusercontent.com/698079/223187536-8e6345c8-2ea4-48d1-830c-ed4871af84a8.png">
</kbd>
</a>
</p>

## Using PoeticMetric

The quickest way to start using PoeticMetric is, [signing up on the managed service that I offer on www.poeticmetric.com](https://www.poeticmetric.com?utm_source=github&utm_term=using). It is fully operated by me, you can simply create your account and start tracking your website's performance right away!
Expand All @@ -22,6 +32,10 @@ PoeticMetric is 100% open source. This means, you can run your own instance of P

I am planning to write a self-hosted installation guide in the future. But for now, you can check out the [`docker-compose.yaml` file in the `self-hosted`](self-hosted/docker-compose.yaml) directory. [You can also find an example `.env` file there](self-hosted/.env.example).

## Sponsoring

If you would like to support the development of PoeticMetric, please consider [sponsoring](https://github.com/sponsors/th0th).

## License

PoeticMetric is free software, and is released under the terms of the **APGL-3.0** (GNU Affero General Public License version 3.0). See [LICENSE](LICENSE).
Binary file modified frontend/components/Home/Preview/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions self-hosted/.env.example
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# CLICKHOUSE
CLICKHOUSE_DATABASE=poeticmetric
CLICKHOUSE_HOST=clickhouse
CLICKHOUSE_PASSWORD=poeticmetric
CLICKHOUSE_PASSWORD=<clickhouse_password>
CLICKHOUSE_TCP_PORT=9000
CLICKHOUSE_USER=poeticmetric

Expand All @@ -11,19 +11,19 @@ COMPOSE_PROJECT_NAME=poeticmetric
# POETICMETRIC
FRONTEND_BASE_URL=<frontend_base_url>
REST_API_BASE_URL=<rest_api_base_url>
VERSION=0.1.0-alpha7
VERSION=latest
WORKER_COUNT=10

# POSTGRES
POSTGRES_DATABASE=poeticmetric
POSTGRES_HOST=postgres
POSTGRES_PASSWORD=poeticmetric
POSTGRES_PASSWORD=<postgres_password>
POSTGRES_PORT=5432
POSTGRES_USER=poeticmetric

# RABBITMQ
RABBITMQ_HOST=rabbitmq
RABBITMQ_PASSWORD=poeticmetric
RABBITMQ_PASSWORD=<rabbitmq_password>
RABBITMQ_PORT=5672
RABBITMQ_USER=poeticmetric
RABBITMQ_VHOST=poeticmetric
Expand Down

0 comments on commit 50c330e

Please sign in to comment.