fathom/README.md

Ana. Open Source Web Analytics.
==============================

[![Go Report Card](https://goreportcard.com/badge/github.com/dannyvankooten/ana)](https://goreportcard.com/report/github.com/dannyvankooten/ana)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/dannyvankooten/ana/master/LICENSE)


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](https://github.com/dannyvankooten/ana/raw/master/assets/img/screenshot.png?v=6)

## 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. Install Go dependencies: `./do install_dependencies`
3. Run the database migrations: `./do database_migrate up`
3. Compile into binary: `./do bin`
4. Create your user account: `./ana -create_user -email="johndoe@email.com" -password="...."`
5. Run default Gulp task to build static assets: `gulp`
6. Start the webserver: `./ana` & 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. You should also set-up a cronjob to run the `./ana -archive_data` command periodically (eg every day).

```html
<!-- 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.