Skip to content
View AnalyticalJS's full-sized avatar

Block or report AnalyticalJS

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
AnalyticalJS/README.md

Analytical JS

Open source, transparent, simple and free for all website analytics.

About the project

Analytical JS aims to be a simple, transparent and open source website statistics that anyone can use for free.

Either clone the source or use it at https://analyticaljs.com for free and help make the internet more open and transparent. Just enter your website domain and install Analytical JS.

See the statistics of iDev.Games here: https://analyticaljs.com/site/idev.games

Analytical JS is built upon the Laravel framework.

How to Install

First clone the project into your local environment. You will need to point your development domain towards the public_html folder within the cloned repository folder:

git clone https://github.com/AnalyticalJS/AnalyticalJS.git

Then navigate to your folder through command line. Something like the below example depending on OS:

cd /home/usr/code/AnalyticalJS

And then run composer install (Install composer if not installed):

composer install

Then change the .env.example into .env. Then fill the details in for the database, APP_URL and APP_URL_PROD. Then run the key generate command in the Analytical JS repository folder:

php artisan key:generate

And then run npm install (Install node if not installed):

npm install

Then migrate the database tables:

php artisan migrate

After this you can either use:

npm run dev

OR

npm run watch

These development build of the assets will include URLs from what you entered into APP_URL in the .env file. Allowing Analytical JS to work from your local setup. Visiting the site locally and viewing the domain page for the local domain should show the statistics.

If you run:

npm run production

You'll build the asset files with the APP_URL_PROD environment variable. Which should be your production URL. So this should always be run before pushing up.

Analytical JS processes data in the background, for this to happen. You'll need to set up a cron job like the below (Instead changing the path to your project folder):

*	*	*	*	*	cd /home/usr/code/AnalyticalJS/ && /usr/local/bin/php artisan schedule:run >> /dev/null 2>&1

When the stats are processed they are then saved into cache for fast loading when viewing the stats. By default the cache is set to "file" in your .env file. For a few stats of development testing this is fine. I recommend setting up either memcached or redis for in memeory cache which are far more capable.

Popular repositories Loading

  1. AnalyticalJS AnalyticalJS Public

    Open source, transparent, simple and free for all website analytics.

    PHP 6