status-im
/
fathom
mirror of https://github.com/status-im/fathom.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
fathom/README.md

1.8 KiB
Raw Blame History

Ana. Open Source Web 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.

Screenshot of the Ana dashboard

Installation

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

  1. Rename .env.example to .env and set your database credentials.
  2. Create or migrate the database: export $(cat .env | xargs) && $GOPATH/bin/migrate -url mysql://$ANA_DATABASE_USER:$ANA_DATABASE_PASSWORD@$ANA_DATABSE_HOST/$ANA_DATABASE_NAME -path ./db/migrations up
  3. Compile into binary: make
  4. Create your user account: ana register <email> <password>
  5. Run default Gulp task to build static assets: gulp
  6. Start the webserver: ana server --port=8080 & visit localhost:8080 to access your analytics dashboard.

To start tracking, include the following JavaScript on your site and replace ana.dev with the URL to your Ana instance.

<!-- Ana tracker -->
<script>
(function(d, w, u, o){
	w[o]=w[o]||function(){
		(w[o].q=w[o].q||[]).push(arguments)
	};
	a=d.createElement('script'),
	m=d.getElementsByTagName('script')[0];
	a.async=1; a.src=u;
	m.parentNode.insertBefore(a,m)
})(document, window, '//ana.dev/tracker.js', 'ana');
ana('setTrackerUrl', '//ana.dev/collect');
ana('trackPageview');
</script>
<!-- / Ana tracker -->

License

MIT licensed.