Fathom Lite. Simple, privacy-focused website analytics. Built with Golang & Preact. https://usefathom.com/
Go to file
Danny fb5cd41a34 restyle login page 2018-05-11 14:15:58 +02:00
assets restyle login page 2018-05-11 14:15:58 +02:00
pkg Merge branch 'master' of github.com:usefathom/fathom 2018-05-11 10:54:47 +02:00
vendor use packr to embed migration files & web assets into binary. closes #8 2018-05-08 14:57:08 +02:00
.env.example generate default value for secret so that fathom can run using only default values 2018-05-08 12:45:24 +02:00
.gitignore add support for sqlite. #9 2018-05-08 12:31:51 +02:00
Dockerfile use multi-stage docker build to compile in container too 2018-05-10 21:31:30 +02:00
LICENSE MIT license it is. Add readme instructions for getting a dev version running 2016-12-11 10:05:29 +01:00
Makefile make sure assets are built before running packr 2018-05-08 15:29:33 +02:00
NOTES.md add test for GetRequestParams 2018-05-08 08:22:21 +02:00
README.md Update development installation instructions 2018-05-08 15:01:21 +02:00
docker-compose.yml update docker-compose file to version 3 & use new fathom image 2018-05-10 22:21:31 +02:00
fathom.go use packr to embed migration files & web assets into binary. closes #8 2018-05-08 14:57:08 +02:00
gulpfile.js [wip] move bulk of storage to client-side for improved scalability, simplicity and privacy. see #14. 2018-05-06 11:53:19 +02:00
package-lock.json [wip] move bulk of storage to client-side for improved scalability, simplicity and privacy. see #14. 2018-05-06 11:53:19 +02:00
package.json [wip] move bulk of storage to client-side for improved scalability, simplicity and privacy. see #14. 2018-05-06 11:53:19 +02:00

README.md

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. Ensure you have Golang installed properly
  2. Get code: git clone git@github.com:usefathom/fathom.git $GOPATH/src/github.com/usefathom/fathom
  3. Compile into binary & prepare assets: make all
  4. Register your user account: fathom register <email> <password>
  5. Start the webserver: fathom server --port=8080 and then visit http://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 (twice).

<!-- 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 -->

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