From 3a55b79f4e225bdd47e4520f81a9ed31997a8554 Mon Sep 17 00:00:00 2001 From: Tejas Gupta Date: Thu, 2 Jan 2025 22:38:51 +0530 Subject: [PATCH] Update README.md --- README.md | 221 +++++++++++++++++++++++------------------------------- 1 file changed, 95 insertions(+), 126 deletions(-) diff --git a/README.md b/README.md index f85c1bd..bf210ce 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Dataverse -###### Data Visualisation Software & Personal Finance Tracker +###### Data Visualisation Software & Finance Tracker @@ -22,7 +22,24 @@ Website - +--- + +### Table of Contents + + + + + + + + + + + +
About DataverseApplication PreviewVersionsRepository StructureUse DataverseMake ContributionsWebsite
+ +--- + ### Featured In @@ -44,59 +61,71 @@
+### 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. + --- -### Table of Contents +### Preview +
- - - - - - - - - - - -
About DataverseVersionsUse DataverseRepository StructurePreviewSoftware RepresentationMake ContributionsWebsite
+Software GUI +
+ +

+
+

View More


+Software Home Page +
+ +

+Visualised Data +
+ +

+Stored Data +
+ +
+
--- -### 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 -- v.XM45'24 Under Development -- v.6550(24) Latest -- v.06.02.24 +| 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. | --- -### Prerequisites -For Data Visualization -- Ensure that a Python interpreter is installed on your computer. If not, download it from [ Python's official website](https://www.python.org/downloads/). +### Repository Structure -For Finance Tracker -- Install MySQL on your computer. If you don't have it, you can download it from [here](https://dev.mysql.com/downloads/installer/). +| [**📂 View _Repository Structure_**](/Documentation/PROJECT_STRUCTURE.md) | +|-| --- -### Development Specifications +### Deployment Specifications +I. Navigate to the directory where you want to deploy the dataverse application and open terminal or command prompt there. -1. **Clone the Project** - ``` - git clone https://github.com/multiverseweb/Dataverse.git - ``` +II. Run the following commands in terminal: + +> ``` +> git clone https://github.com/multiverseweb/Dataverse.git +> ``` -2. **Create a Virtual Environment (optional but recommended)** +III. Create a Virtual Environment (optional but recommended) - On Windows: ``` @@ -111,82 +140,27 @@ source venv/bin/activate ``` -3. **Navigate to the Project's software Directory** - - ``` - cd Dataverse/software - ``` - -4. **Install Dependencies** - - - Install all the required Python packages using `requirements.txt`: - - ``` - pip install -r ../installation/requirements.txt - ``` - -5. **Finance Tracker Setup** - -- 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: +IV. Install dependencies: - ``` - python main.py - ``` +> ``` +> cd Dataverse +> ``` +> ``` +> pip install -r installation/requirements.txt +> ``` - - Alternatively, open `main.py` in VSCode and run it. +V. Install MySQL if you don't have it already from [here](https://dev.mysql.com/downloads/installer/). -7. **Deactivate the Virtual Environment** +> [!IMPORTANT] +> Change the values of `DB_HOST`, `DB_USER` and `DB_PASSWORD` in [software/db_config.py](software/db_config.py) file according to your MySQL account. -- After you’re done working with the project, you can deactivate the virtual environment: +VI. Run the application: - ``` - deactivate - ``` +> ``` +> python software/main.py +> ``` -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 -Back to top -
- -Software GUI -
- -

-
-

View More


-Visualised Finance Data -
- -

-Relational Data -
- -
-
- ---- - -### Software Representation -Back to top - -ER Diagram for Finance Tracker -![](/website/web_images/ER_diagram.png) +Now, the software should run smoothly with no errors, feel free to use the software and don't forget to give feedback on [Dataverse's website](https://multiverse-dataverse.netlify.app/)! --- @@ -212,38 +186,30 @@ ER Diagram for Finance Tracker /> -### Contributions -Back to top - -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 I can review and merge it. +### Contributions +Want to make contributions to this project? ✨ +| **[Read _contribution guidelines!_](Documentation/contributing.md)** | +|-| +--- -### Our Valuable Contributors ❤✨ +### Our Valuable Contributors ❤️ [![Contributors](https://contrib.rocks/image?repo=multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/graphs/contributors) - -### Stargazers ❤ +### Stargazers ⭐
[![Stargazers repo roster for @multiverseweb/Dataverse](https://reporoster.com/stars/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/stargazers) -
-### Forkers ❤ +### Forkers 🍴 [![Forkers repo roster for @multiverseweb/Dataverse](https://reporoster.com/forks/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/network/members) @@ -253,5 +219,8 @@ Want to contribute to this project? Follow these steps: ||[Visit Dataverse's Website](https://multiverse-dataverse.netlify.app/)| |-|-| +Back to top + +``` -Back to top \ No newline at end of file +```