mirror of https://github.com/status-im/fathom.git
Fathom Lite. Simple, privacy-focused website analytics. Built with Golang & Preact.
https://usefathom.com/
6ae3b422d1
screenshot of the v1 dash. |
||
---|---|---|
assets | ||
pkg | ||
vendor | ||
.env.example | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
README.md | ||
docker-compose.yml | ||
fathom.go | ||
gulpfile.js | ||
package-lock.json | ||
package.json |
README.md
Fathom - simple website analytics
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.
Installation
For getting a development version of Fathom up & running, please go through the following steps.
- get code:
go get -u github.com/usefathom/fathom
(orgit clone
repo into your$GOPATH
) - run
npm install
(in code directory) to install all required dependencies - Rename
.env.example
to.env
and set your database credentials. - Compile into binary:
make
- Create your user account:
fathom register <email> <password>
- Run default Gulp task to build static assets:
gulp
- 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.