Fathom Lite. Simple, privacy-focused website analytics. Built with Golang & Preact. https://usefathom.com/
Go to file
Danny 0b68a519fb rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
assets rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
pkg check err in user register command 2018-04-23 10:50:31 +02:00
vendor change project directory structure to clean-up root dir 2018-04-20 13:12:23 +02:00
.env.example update readme, database migrations will now run automatically 2017-01-25 15:19:08 +01:00
.gitignore rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
Dockerfile rebrand executable & README to fathom 2018-04-24 10:12:38 +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 rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
README.md rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
docker-compose.yml Create Dockerfile and add example docker-compose.yml 2016-12-25 16:33:57 +01:00
fathom.go rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
gulpfile.js rebrand executable & README to fathom 2018-04-24 10:12:38 +02:00
package-lock.json upgrade client-side code for Preact 8.x 2018-04-23 10:11:51 +02:00
package.json upgrade client-side code for Preact 8.x 2018-04-23 10:11:51 +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. get code: go get -u github.com/usefathom/fathom (or git clone repo into your $GOPATH )
  2. run npm install (in code directory) to install all required dependencies
  3. Rename .env.example to .env and set your database credentials.
  4. Compile into binary: make
  5. Create your user account: fathom register <email> <password>
  6. Run default Gulp task to build static assets: gulp
  7. Start the webserver: fathom server --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 -->

License

MIT licensed.