AutoDash is an advanced tool designed to revolutionize data analysis by automating the creation of interactive dashboards from multiple data sources. Leveraging a fine-tuned Llama3 LLM specifically tailored for data analytics, AutoDash transforms complex data into actionable insights through real-time updates and intuitive natural language interactions. The tool integrates a Python-based RAG (Retrieval-Augmented Generation) framework, enabling seamless querying and generation of SQL, NoSQL, and other database queries using natural language prompts. This versatility allows for efficient and precise analysis across a wide range of data platforms. AutoDash also prioritizes security, ensuring that all data processing remains within the company's servers, providing dynamic visualizations and empowering businesses to make informed decisions effortlessly.
- Project Overview
- Prerequisites
- Setup Instructions
- Tech Stack
- Usage
- Contribution Guidelines
- FAQs
- Roadmap
AutoDash is a cutting-edge solution designed to simplify the data analysis process by automating the creation of interactive, real-time dashboards. With a secure in-house processing system, AutoDash ensures that your data remains within your company’s infrastructure, offering both efficiency and peace of mind. The tool's AI-driven insights and dynamic visualizations empower businesses to make informed decisions quickly and accurately.
Before you begin, ensure you have the following installed:
- Python 3.8+
- Node.js and NPM
- JDK 21
- Maven
- MySQL
- Nginx
Repository Link: AutoDash API
Steps:
-
Clone the Repository:
git clone https://github.com/techcodebhavesh/AutoDash.git cd AutoDash
-
Create a Python Virtual Environment:
python3 -m venv pyenv source pyenv/bin/activate
-
Install Required Packages:
pip install -r requirements.txt
-
Environment Configuration:
- Copy the example environment file:
cp .env.example .env
- Edit the
.env
file with your credentials and other required configurations.
- Copy the example environment file:
-
Run the Flask Server:
python run.py
-
Nginx Setup:
- Ensure Nginx is installed and configured to proxy requests to the Flask server.
Repository Link: AutoDash Frontend
Steps:
-
Clone the Repository:
git clone https://github.com/Vaishnavi4008/Autodash_frontend.git cd Autodash_frontend
-
Environment Configuration:
- Copy the example environment file:
cp .env.example .env
- Edit the
.env
file with your credentials or any required configuration changes.
- Copy the example environment file:
-
Install Dependencies:
npm install
-
Run the Development Server:
npm run dev
- This will start the Vite development server, and the frontend will be accessible at
http://localhost:5173
.
- This will start the Vite development server, and the frontend will be accessible at
Repository Link: AutoDash Java API
Steps:
-
Clone the Repository:
git clone https://github.com/SpectacularVoyager/AutodashJava.git cd AutodashJava
-
Install JDK 21:
- Ensure that JDK 21 is installed on your system.
-
Build the Project:
mvn clean install
-
Run the Spring Boot Application:
mvn spring-boot:run
-
Database Setup:
- SQL files are located in the
res/sql.sql
directory. - Configure MySQL settings in
src/main/resources/jdbc.properties
.
- SQL files are located in the
- Backend: Flask (Python), Spring Boot (Java)
- Frontend: React (JavaScript), Vite
- Database: MySQL
- Other: Nginx, Maven, JDK 21
Once all services are running, you can access AutoDash through your browser at http://localhost:5173
.
- Data Integration: Connect multiple data sources through the dashboard.
- Natural Language Queries: Use the fine-tuned Llama3 LLM for intuitive data queries.
- Dynamic Visualizations: Customize and interact with data visualizations in real time.
We welcome contributions to AutoDash! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Make your changes and commit them (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature-branch
). - Open a Pull Request.
For more details, refer to our CONTRIBUTING.md
file.
Q: What if I encounter a ModuleNotFoundError
?
A: Ensure all dependencies are installed as per the requirements.txt
or package.json
files.
Q: How do I configure MySQL for the Java backend?
A: Edit the jdbc.properties
file in src/main/resources
with your MySQL credentials.
Q: How do I set up Nginx for the Python backend? A: Follow standard Nginx setup procedures, ensuring it proxies requests to the Flask server.
- Version 2.0: Multi-tenant support and enhanced security features.
- Version 3.0: Expanded LLM capabilities for more complex data queries.
- Future Plans: Integration with more data sources and enhanced visualization options.