Grafieks Desktop

An open-source Business Intelligence platform built with Qt5, C++ and D3.js

As of 14/07/2024, we have decided to discontinue the open-source version of this project. This decision was made after careful consideration of our resources and long-term goals. We are incredibly grateful for the support and contributions from the community over the years. While the repository will remain available for historical reference, no further updates or support will be provided. We encourage users to fork the repository if they wish to continue development independently. Thank you for your understanding and continued interest.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation and Setup
3. Product Screenshots
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Grafieks is an open-source, simple Self-Service Business Intelligence tool that allows users to quickly and easily extract meaningful insights from data. With Grafieks, line-of-business professionals can connect to data sources, build data models or write SQL queries, and build reports on their own, with minimal IT support.

Currently supported databases

File based

1. CSV
2. JSON
3. Microsoft Excel

RDBMS

1. Amazon Redshift
2. Microsoft Access
3. MySql
4. PostgresSQL
5. Sqlite
6. Snowflake
7. Micorosft Sql Server
8. Teradata

NoSql

1. Mongodb

Cloud Storage

1. Box
2. Dropbox
3. Google Drive

Online Services

1. Github Gists
2. Google Sheets

Chart types

1. Bar Chart
   a) Bar Chart
   b) Grouped Bar Chart
   c) Stacked Bar Chart
   d) Horizontal Bar Chart
   e) Horizontal Grouped Bar Chart
   f) Horizontal Stacked Bar Chart
   
2. Line Chart
   a) Line Chart
   b) Horizontal Line Chart
   c) Multiple Line Chart
   
3. Area Chart
   a) Area Chart
   b) Stacked Area Chart
   
4. Pie Chart
   
5. Donut Chart
   
6. Radar Chart
   
7. Scatter Plot
   
8. Funnel
   
9. Gauge
   
10. Heat Map
    
11. Sunburst
    
12. Tree Chart
    
13. Waterfall Chart
    
14. Pivot
    
15. Table
    

Note: Currently, it has been tested to work with Windows 10 and 11 only. On other OS, some of the features may not work.

(back to top)

Built With

Core technologies behind the application

• Qt5 - Only open-source modules used.
• C++ 11
• Javascript
• D3js
• DuckDb

(back to top)

Getting Started

This section gives a set of instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

When you clone for first time

git clone --recurse-submodules https://github.com/Grafieks-Analytics/grafieks-desktop/

Already cloned or missed cloning with -recurse-submodule flag

git submodule update --init

These commands will add a folder "Charts" at Sources/ folder

Below command will install all required packages and build.

cd Source/Charts
npm install
npm run build

Prerequisites

Please choose whichever is applicable. You do not need to install all. e.g, if you need to process Mysql database, please download Mysql driver only.

Links to drivers for various databases to connect as datasource

Windows 10 & 11 drivers

1. Amazon Redshift driver
2. Microsoft Access. You need to have Microsoft office installed on your system
3. Mongodb
4. MySql
5. PostgresSQL
6. Snowflake
7. Micorosft Sql Server
8. Teradata
9. Microsoft Excel. You need to have Microsoft office installed on your system

For those connectors not mentioned above, no special download is required.

Installation and Setup

Important step

• Rename Code/secrets.sample.h to Code/secrets.h and put up your credentials, else online storages section will not work. Remember to remove all the commented section in the body

• For detailed installation and setup on Windows, Refer this Document

• Duckdb v0.2.9 dll file is already included with the setup. However, if you manually want to install and setup Duckdb on Windows, Refer this Document.

• To understanding the QML layout file, Read this Document

(back to top)

Product Screenshots

Data Connector Screen

Report Designer Screen

Dashboard Designer Screen

Roadmap (till now)

• Connect to datasources
• Datasource filters, Report filters & Dashboard filters
• Publish datasources
• Create reports
• Create and publish dashboards

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL v3 License. See LICENSE.txt for more information.

(back to top)

Contact

• Project Link: https://www.grafieks.com/
• Github: https://github.com/Grafieks-Analytics/grafieks-desktop

(back to top)

Acknowledgments

We would like to thank the following repositories for their contribution to the open-source community

• DuckDb
• Nlohmann JSON
• D3.js

(back to top)