multiverseweb · Rucha-Ambaliya · Jan 2, 2025 · Jan 2, 2025 · Jan 2, 2025 · Jan 2, 2025
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Dataverse
 <img src="website/web_images/3d_glow.webp" height=50px align=right>
 
-###### Data Visualisation Software & Finance Tracker
+###### Data Visualisation Software & Personal Finance Tracker
 
 <!--![Visitors](https://api.visitorbadge.io/api/visitors?path=multiverseweb/Dataverse%20&countColor=%2523263759&style=for-the-badge)-->
 
@@ -22,24 +22,7 @@
   <a href="https://multiverse-dataverse.netlify.app/"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fmultiverse-dataverse.netlify.app%2F&up_message=awake&up_color=%2300d18f&down_message=asleep&down_color=red&style=flat">
 </a>
 
----
-
-### Table of Contents
-
-<table>
-  <tr>
-    <th><a href="#what-does-this-software-do">About Dataverse</a></th>
-<th><a href="#preview">Application Preview</a></th>
-    <th><a href="#versions">Versions</a></th>
-    <th><a href="#repository-structure">Repository Structure</a></th>
-    <th><a href="#deployment-specifications">Use Dataverse</a></th>
-    <th><a href="#contributions">Make Contributions</a></th>
-    <th><a href="#website">Website</a></th>
-  </tr>
-</table>
-
----
-
+
 ### Featured In
 
 <table>
@@ -61,101 +44,150 @@
     </tr>
 </table>
 
-### What does this software do?
-- Supports all data visualisation techniques, basic as well as advanced.
-- Generates interactive, customizable and exportable graphs.
-- Provides data storage for later use.
-- Supports data inputs from excel sheets.
-- Simplifies expense tracking and financial management.
-- Allows user to download financial reports.
-- Uses encryption techniques to securely store your passwords.
-- View and manage data via a mobile-friendly website.
-- Provides predictive analytics and trend analysis using ML techniques.
-
 ---
 
-### Preview
-<div align=center>
+### Table of Contents
 
-Software GUI
-<br>
-<img src="software/images/preview.png" width="800px">
-<br><br>
-<details> 
- <summary align=left><H4>View More</H4></summary><br>
-Visualised Finance Data
-<br>
-<img src="website/web_images/finance_down.webp" width="800px">
-<br><br>
-Relational Data
-<br>
-<img src="website/web_images/data.png" width="800px">
-</details>
-</div>
+<table>
+  <tr>
+    <th><a href="#what-does-this-software-do">About Dataverse</a></th>
+    <th><a href="#versions">Versions</a></th>
+    <th><a href="#deployment-specifications">Use Dataverse</a></th>
+    <th><a href="#repository-structure">Repository Structure</a></th>
+    <th><a href="#preview">Preview</a></th>
+    <th><a href="#software-representation">Software Representation</a></th>
+    <th><a href="#contributions">Make Contributions</a></th>
+    <th><a href="#website">Website</a></th>
+  </tr>
+</table>
 
 ---
 
+### What does this software do?
+- This software can be used to visualise data in many basic as well as advanced forms.
+- It allows the user to download the generated charts.
+- It can be used as a finance tracker, providing various useful outputs.
+- It supports data inputs from excel sheets.
+- The data can also be stored for later use.
+- Uses encryption techniques to securely store your passwords.
+
+---
 ### Versions
 
-| Version | Description |
-|-------------|-----------------|
-| v.XM45.24 `Under Development` | High scale installable vesrion currently being developed, has improved UI based on glassmorphism. Makes the project mobile-friendly and provides more analytical features. Seeks major contributions through SWOC-S5. |
-| v.6550.24 `Latest` | Current stable version that supports most of the data visualisation techniques and finance tracking. Major development done during GSSoC'24. |
-| v.06.02.24 | Initial version developed on 6th February, 2024. Only supports finance tracking. |
+- v.XM45'24 Under Development
+- v.6550(24) Latest
+- v.06.02.24
 
 ---
 
-### Repository Structure
+### Prerequisites
+<highlight>For Data Visualization</highlight>
+- Ensure that a Python interpreter is installed on your computer. If not, download it from [ Python's official website](https://www.python.org/downloads/).
 
-| [**📂 View _Repository Structure_**](/Documentation/PROJECT_STRUCTURE.md) |
-|-|
+<highlight>For Finance Tracker</highlight>
+- Install MySQL on your computer. If you don't have it, you can download it from [here](https://dev.mysql.com/downloads/installer/).
 
 ---
 
-### Deployment Specifications
+### Development Specifications
 
-Dataverse is currently under development. It will be available for installastion soon.
+1. **Clone the Project**  
+    ``` 
+    git clone https://github.com/multiverseweb/Dataverse.git
+    ```
 
-However, you can follow these steps to run the project locally on your computer:
-> [!IMPORTANT]
-> Don't forget to read the [prerequisites](#prerequisites).
+2. **Create a Virtual Environment (optional but recommended)**
+  - On Windows:
 
+    ```
+    python -m venv venv
+    venv\Scripts\activate
+    ```
 
-   - Clone the project
-
-      ```
-     git clone https://github.com/multiverseweb/Dataverse.git
-      ```
+  - On macOS/Linux:
 
-   -  Open `software` folder in VSCode.
+    ```
+    python3 -m venv venv
+    source venv/bin/activate
+    ```
 
-      ```
-      cd Dataverse/software
-      ```
+3. **Navigate to the Project's software Directory**  
+
+    ```
+    cd Dataverse/software
+    ```
 
-   - Go to `main.py` and run it.
+4. **Install Dependencies**
 
-Now the software should run locally with no errors, feel free to use the software and don't forget to give feedback on the [website](https://multiverse-dataverse.netlify.app/)!
+  -  Install all the required Python packages using `requirements.txt`:
 
----
+      ```
+      pip install -r ../installation/requirements.txt
+      ```
 
-### Prerequisites
-<highlight>For Data Visualization</highlight>
-- You must have a python interpreter installed on your computer.
-- You must have python packages such as `numpy, pandas, matplotlib, tkinter`.
+5. **Finance Tracker Setup**
 
-  ```
-  pip install package_name
-  ```
-<highlight>For Finance Tracker</highlight>
-- For using the Finance Tracker, you must have `MySQL` installed on your computer. If you don't have it you can download it from [here](https://dev.mysql.com/downloads/installer/).
-- Go to `line no. 15` under `connecting MySQL` section of `financeTracker.py` and change the values of `host, user and passwd` according to your MySQL account.
+- Open `financeTracker.py` (located in Dataverse/software/) and update `line no. 17` under the `connecting MySQL` section with your MySQL credentials (`host, user, and passwd`).
 - Also, run the command
   ```
   CREATE DATABASE DATAVERSE;
   ```
   on your MySQL workbench or commandline client.
 
+6. **Run the Project**
+
+  - Run main.py using the command:
+
+    ```
+    python main.py
+    ```  
+
+  - Alternatively, open `main.py` in VSCode and run it.
+
+7. **Deactivate the Virtual Environment**
+
+- After you’re done working with the project, you can deactivate the virtual environment:
+
+  ```
+  deactivate
+  ```
+
+Now the software should run locally with no errors, feel free to use the software and don't forget to give feedback on the [website](https://multiverse-dataverse.netlify.app/)!
+
+---
+
+### Repository Structure
+
+📂 [Repository Structure](/Documentation/PROJECT_STRUCTURE.md)
+
+### Preview
+<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
+<div align=center>
+
+Software GUI
+<br>
+<img src="software/images/preview.png" width="800px">
+<br><br>
+<details> 
+ <summary align=left><H4>View More</H4></summary><br>
+Visualised Finance Data
+<br>
+<img src="website/web_images/finance_down.webp" width="800px">
+<br><br>
+Relational Data
+<br>
+<img src="website/web_images/data.png" width="800px">
+</details>
+</div>
+
+---
+
+### Software Representation
+<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
+
+ER Diagram for Finance Tracker
+![](/website/web_images/ER_diagram.png)
+
 ---
 
 ### Star History
@@ -181,31 +213,37 @@ Now the software should run locally with no errors, feel free to use the softwar
 </picture>
 
 ### Contributions
+<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
 
 Want to contribute to this project? Follow these steps:
 
 - Star the Repository.
 - Go to [issues](https://github.com/multiverseweb/Dataverse/issues), find an issue that you can solve or create a new issue.
 - Fork the repository.
-- Create a new branch (`git checkout -b feature-branch`).
-- Go to [`line no. 1` in script.js](https://github.com/multiverseweb/Dataverse/blob/main/website/scripts/script.js#L5-L7) and append the name of your city to the `cities` array. (optional)
-- Make your contributions and commit them (`git commit -m 'Add feature'`).
-- Push to the branch (`git push origin feature-branch`).
-- Create a Pull Request, so we can review and merge it.
+- Create a new branch (git checkout -b feature-branch).
+- Go to [line no. 1 in script.js](https://github.com/multiverseweb/Dataverse/blob/main/website/scripts/script.js#L5-L7) and append the name of your city to the cities array. (optional)
+- Make your contributions and commit them (git commit -m 'Add feature').
+- Push to the branch (git push origin feature-branch).
+- Create a Pull Request, so I can review and merge it.
 
-### Our Valuable Contributors ❤️✨
+
+
+
+### Our Valuable Contributors ❤✨
 
 [![Contributors](https://contrib.rocks/image?repo=multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/graphs/contributors)
 
-### Stargazers ❤️
+
+### Stargazers ❤
 
 <div align='left'>
 
 [![Stargazers repo roster for @multiverseweb/Dataverse](https://reporoster.com/stars/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/stargazers)
 
+
 </div>
 
-### Forkers ❤️
+### Forkers ❤
 
 [![Forkers repo roster for @multiverseweb/Dataverse](https://reporoster.com/forks/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/network/members)
 
@@ -215,8 +253,5 @@ Want to contribute to this project? Follow these steps:
 |<a href="https://multiverse-dataverse.netlify.app/"><img src="Documentation/images/netlify.svg"></a>|[Visit Dataverse's Website](https://multiverse-dataverse.netlify.app/)|
 |-|-|
 
-<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
-
-```
 
-```
+<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
diff --git a/software/__pycache__/financeTracker.cpython-312.pyc b/software/__pycache__/financeTracker.cpython-312.pyc
diff --git a/software/financeTracker.py b/software/financeTracker.py
@@ -14,7 +14,7 @@
 colors=["#440154", "#3b528b","#21918c", "#5ec962", "#fde725","#f89540", "#e16462","#b12a90", "#6a00a8", "#0d0887", "#3474eb", "#5ec962", "yellow", "#f89540", "tomato","tan"]
 #==================================================================================================connecting MySQL
 try:
-    mycon = my.connect(host='localhost', user='root', passwd='tejas123', database='dataverse')  # Declared as constant
+    mycon = my.connect(host='localhost', user='root', passwd='root', database='dataverse')  # Declared as constant
     cursor = mycon.cursor()  # Declared as constant
 except Error as e:
     print(f"Error connecting to MySQL: {e}")