/insights

Free and Open Source Data Analytics Tool for your Frappe Apps

Primary LanguageVueGNU Affero General Public License v3.0AGPL-3.0

Frappe Insights logo

Free and Open Source Data Analytics Tool for your Frappe Apps

codecov unittest

Hero Image
Preview - Documentation

Features

  • Multiple Data Sources - Connect to multiple data sources and query them at one place.
  • Complex Queries - Write complex queries get the results in a tabular format.
  • Visualize Data - Visualize your data in the form of charts.
  • Dashboards - Create dashboards to automate tracking of important metrics.

Installation

Docker

You need Docker, docker-compose and git setup on your machine. Refer Docker documentation. After that, run the following commands:

git clone https://github.com/frappe/insights
cd insights/docker
docker-compose up

Wait for sometime until the setup script creates a site. After that you can Open the URL http://insights.test:8000/insights in your browser, you should see the app running should show up.

Local

To setup the repository locally follow the steps mentioned below:

  1. Install bench and setup a frappe-bench directory by following the Installation Steps
  2. Start the server by running bench start
  3. In a separate terminal window, create a new site by running bench new-site insights.test
  4. Map your site to localhost with the command bench --site insights.test add-to-hosts
  5. Get the Insights app. Run bench get-app https://github.com/frappe/insights
  6. Run bench --site insights.test install-app insights.
  7. Now open the URL http://insights.test:8000/insights in your browser, you should see the app running

Contributions and Community

There are many ways you can contribute even if you don't code:

  1. You can start by giving a star to this repository!
  2. If you find any issues, even if it is a typo, you can raise an issue to inform us.
  3. You can join our telegram group and share your thoughts.

License

GNU Affero General Public License v3.0