Skip to content

Fathom. Simple, trustworthy website analytics. Built with Golang & Preact.

License

Notifications You must be signed in to change notification settings

austinginder/fathom

 
 

Repository files navigation

Fathom - simple website analytics

Go Report Card MIT licensed

This is nowhere near being usable, let alone stable. Please treat as a proof of concept while we work on getting this to a stable state. Do not run Fathom in production yet unless you like spending time on it. Things will keep changing for the next few months.

Screenshot of the Fathom dashboard

Installation

For getting a development version of Fathom up & running, please go through the following steps.

  1. get code: go get -u github.com/usefathom/fathom (or git clone repo into your $GOPATH )
  2. compile into binary & prepare assets: make all
  3. Rename .env.example to .env and set your database credentials.
  4. Create your user account: fathom register <email> <password>
  5. Start the webserver: fathom server --webroot=./build --port=8080 & visit localhost:8080 to access your analytics dashboard.

To start tracking, include the following JavaScript on your site and replace yourfathom.com with the URL to your Fathom instance.

<!-- Fathom - simple website analytics - https://github.com/usefathom/fathom -->
<script>
(function(f, a, t, h, o, m){
	a[h]=a[h]||function(){
		(a[h].q=a[h].q||[]).push(arguments)
	};
	o=f.createElement('script'),
	m=f.getElementsByTagName('script')[0];
	o.async=1; o.src=t;
	m.parentNode.insertBefore(o,m)
})(document, window, '//yourfathom.com/tracker.js', 'fathom');
fathom('setTrackerUrl', '//yourfathom.com/collect');
fathom('trackPageview');
</script>
<!-- / Fathom -->

Copyright and license

MIT licensed. Fathom and Fathom logo are trademarks of Fathom Analytics.

About

Fathom. Simple, trustworthy website analytics. Built with Golang & Preact.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 51.4%
  • JavaScript 30.7%
  • CSS 16.0%
  • Makefile 1.5%
  • HTML 0.4%