mirror of https://github.com/status-im/fathom.git
Fathom Lite. Simple, privacy-focused website analytics. Built with Golang & Preact.
https://usefathom.com/
ec6d3e004b | ||
---|---|---|
api | ||
assets | ||
commands | ||
count | ||
db | ||
models | ||
vendor | ||
views | ||
.babelrc | ||
.env.example | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
Makefile | ||
README.md | ||
ROADMAP.md | ||
ana.go | ||
docker-compose.yml | ||
gulpfile.js | ||
package.json | ||
yarn.lock |
README.md
Ana. Open Source Web 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.
Installation
For getting a development version of Ana up & running, please go through the following steps.
- Rename
.env.example
to.env
and set your database credentials. - Install Go dependencies:
./do install_dependencies
- Run the database migrations:
./do database_migrate up
- Compile into binary:
./do bin
- Create your user account:
./ana -create_user -email="johndoe@email.com" -password="...."
- Run default Gulp task to build static assets:
gulp
- 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).
<!-- 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.