Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mandrasch/pet-project-analytics

Pet Project Analytics allows you to track pageviews for multiple webpages within WordPress - in a private, cookie-less way. Fork of Koko Analytics.
https://github.com/mandrasch/pet-project-analytics

analytics php privacy selfhosted wordpress

Last synced: 7 days ago
JSON representation

Pet Project Analytics allows you to track pageviews for multiple webpages within WordPress - in a private, cookie-less way. Fork of Koko Analytics.

Awesome Lists containing this project

README 

        
# Pet Project Analytics (WIP)



Pet Project Analytics allows you to track pageviews for multiple external websites - in a privacy-friendly, cookieless way = no cookie banner needed.



This is a fork of [Koko Analytics](https://www.kokoanalytics.com/), an awesome WordPress plugin created by [Danny van Kooten](https://github.com/dannyvankooten). 



Status: 🚧 Work in progress / not intended for live usage yet. 🚧



## Features



- fork of [Koko Analytics](https://www.kokoanalytics.com/) with the ability to track multiple external websites



![](.readme/screenshot_add_new_site.png?raw=true)

![](.readme/screenshot_view_site.png?raw=true)

![](.readme/screenshot_analytics_by_site.png?raw=true)



## Why?



I believe that it would be great to have privacy-friendly analytics available on every (cheap) PHP webhost - so that people can easily track pageviews and referrers for their hobby projects. This could possibly also increase motivation. 



Why forking a Wordpress plugin? Almost every PHP webhost offers 1-click-WordPress installs nowadays -  not all offer composer  or SSH access. Otherwise this would be a nice Laravel Filament project. ;) 



## Local Development



It's easy to get started with WordPress plugin development in [DDEV](https://ddev.readthedocs.io/en/stable/users/install/ddev-installation/).



```bash

git clone [email protected]:mandrasch/pet-project-analytics.git

cd pet-project-analytics/



# Start the DDEV project

ddev start



# Setup and install WordPress, will prompt for an admin password (like password123!)

ddev wp core download

ddev wp core install --url='$DDEV_PRIMARY_URL' --title='NewWordPress' --admin_user=admin [email protected] --prompt=admin_password



ddev launch /wp-admin



# Install composer for plugin (see composer_root in .ddev/config.yaml)

ddev composer install



# Install npm deps, build assets

cd wp-content/plugins/pet-project-analytics

ddev npm install

ddev npm run build



# Needed one time, activate plugin:

ddev wp plugin activate pet-project-analytics

```



If you change CSS/JS, you need to run `ddev npm run build` within `wp-content/plugins/pet-project-analytics` again. Beware: If linting fails, file will be empty. Run `ddev npm run lint` before to check.



Demo site for tracking: [https://pet-project-analytics.ddev.site/demo/](https://pet-project-analytics.ddev.site/demo/)



To check the WP crons, you can use https://de.wordpress.org/plugins/wp-crontrol/. There is `pp_analytics_aggregate_stats` which will read the buffer file and insert visits in the database. By default the buffer file is located at `/wp-content/uploads/pageviews.php`. See `wp-content/debug.log` for debugging / enable WP_DEBUG logging.



Example of buffer file:



```bash



p,1,https://pet-project-analytics.ddev.site/demo-site.html,1,,

```



Linting:



```bash

ddev composer run lint



cd wp-content/plugins/pet-project-analytics

ddev npm run lint



### How to update plugin version (locally)



- change version in pet-project-analytics.php in php code comments as well in `\define('PP_ANALYTICS_VERSION', '1.3.10');` (current version is stored in wp_options)



This will run SQL migrations automatically (see `maybe_run_migration`)



## TODOs



- [x] remove automatic tracking for wordpress site (PHP)

- [ ] remove adding tracking JS to WP Site

- [ ] strip domain from posts/pages (or just don't show it in interface?)

- [ ] reorganize admin menu structure

- [ ] Re-route settings, screen --> move to new parent menu

- [ ] Add cookie detection of unique visitors, allow opt-out as well? Or use plausibles way (cookieless)? https://plausible.io/data-policy#how-we-count-unique-users-without-cookies - but this would mean this needs to be stored in db

    - [ ] https://www.kokoanalytics.com/kb/does-koko-analytics-use-cookies/ - just disable the defaults? problem for GDPR is that "list of viewed pages" could be considered personal data (and therefore acceptance would be needed). because on a shared computer, you could check what the other person visited on a webpage ...

- [ ] remove cookie feature completely + remove visitor counts from dashboard? (more like statify / server logs?)

- [ ] remove dashboard widgets (for now)

- [ ] remove optimized endpoint, we need to use POST/xhr from outside (maybe re-add it later if needed)

- [ ] add Sites screen to add sites (title, domain) - WIP

- [ ] Add sites: proper validation for domains/subdomains

- [ ] View site: update title, domain

- [ ] add siteId to all screens showing stats

- [ ] provide JS tracking script for external sites -> with siteId (or domain detection?)

- [ ] change page tracking (wordpress post/pages) to URL path tracking

- [ ] adapt optimized endpoint with buffer file

- [ ] block request from other domains --> $_REQUEST

- [ ] give proper credit in PHP code comments (how to do it for GNU?)

- [ ] check compatibility with koko-analytics installed next to it

- [ ] fix cronjob

- [ ] check wp-options --> still references to kokoanalytics

- [ ] fix/adapt uninstall

- [ ] rework admin-site-management to use `manage_pp_analytics` cap

- [ ] generally rename to PP Analytics to make it shorter?

- [ ] re-test fresh install, remove wp db ... 

- [ ] test uninstall, is everything removed?

- [ ] release 1.0.0, just for fun



## License



This is licensed as GNU GENERAL PUBLIC LICENSE Version 3. Fork of [ibericode/koko-analytics](https://github.com/ibericode/koko-analytics/) by [Danny van Kooten](https://github.com/dannyvankooten), v1.3.10. Massive kudos to Danny for such a well coded plugin!



Further inspiration were services like Plausible, Fathom Analytics, umami, matomo, Koko Analytics, Statify & co.