diff --git a/Project Structure.md b/Project Structure.md new file mode 100644 index 0000000..8b7d97a --- /dev/null +++ b/Project Structure.md @@ -0,0 +1,50 @@ +## Project Structure πŸ“ +``` +DATAVERSE +β”‚ +└──.github +β”‚ β”œβ”€β”€ ISSUE_TEMPLATE +β”‚ β”‚ β”‚ β”œβ”€β”€ bug_report.md +β”‚ β”‚ β”‚ └── feature_request.md +β”‚ β”œβ”€β”€ PULL_REQUEST_TEMPLATE.md +β”‚ └── workflows +β”‚ β”‚ β”œβ”€β”€ auto-label.yml +β”‚ β”‚ β”œβ”€β”€ greetings.yml +β”‚ β”‚ β”œβ”€β”€ issue-reminder.yml +β”‚ β”‚ β”œβ”€β”€ issue_open_close.yml +β”‚ β”‚ β”œβ”€β”€ pr_merge.yaml +β”‚ β”‚ └── pr_raise.yml +β”‚ +└──.vscode +β”‚ β”‚ +β”‚ └── settings.json +β”‚ +└──software +β”‚ β”œβ”€β”€ database.sql +β”‚ β”œβ”€β”€ financeTracker.py +β”‚ β”œβ”€β”€ finance_tracker.ipynb +β”‚ β”œβ”€β”€ images +β”‚ β”œβ”€β”€ main.py +β”‚ β”œβ”€β”€ report.py +β”‚ └── __pycache__ +β”‚ +└──website +β”‚ β”œβ”€β”€ codeOfconduct.html +β”‚ β”œβ”€β”€ codeOfconduct.js +β”‚ β”œβ”€β”€ contributor.css +β”‚ β”œβ”€β”€ contributor.html +β”‚ β”œβ”€β”€ contributor.js +β”‚ β”œβ”€β”€ license.html +β”‚ β”œβ”€β”€ license.js +β”‚ β”œβ”€β”€ login.html +β”‚ β”œβ”€β”€ script.js +β”‚ β”œβ”€β”€ signup.html +β”‚ β”œβ”€β”€ style.css +β”‚ └── web_images +β”‚ +β”œβ”€β”€Contributing.md +β”œβ”€β”€LICENSE +β”œβ”€β”€README.md +β”œβ”€β”€code_of_conduct.md +└── index.html +``` diff --git a/README.md b/README.md index dd1144e..a784f6b 100644 --- a/README.md +++ b/README.md @@ -1,215 +1,426 @@ -# GSSoc'24 Extended - -## Tech Stack - -![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue) -![MySQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white) -![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white) -![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white) -![Matplotlib](https://img.shields.io/badge/Matplotlib-%2311557c.svg?style=for-the-badge&logo=python&logoColor=white) -![Tkinter](https://img.shields.io/badge/Tkinter-blue?style=for-the-badge&logo=python&logoColor=white) -![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white) -![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white) -![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E) -![Microsoft Excel](https://img.shields.io/badge/Microsoft_Excel-217346?style=for-the-badge&logo=microsoft-excel&logoColor=white) - -#### Read the description below and [start contributing](#contributions) now! If you like the project, show some love ❀️ and star the repo! ⭐ - -> [!IMPORTANT] -> Look for issues labeled with and ask for assignment if you can solve them. - ---- - -# Dataverse - - -###### Data Visualisation Software & Personal Finance Tracker - - - - -![Visitors](https://api.visitorbadge.io/api/visitors?path=multiverseweb2%2Dataverse%20&countColor=%23263759&style=flat&initial=5767) - ![Github](https://img.shields.io/github/license/multiverseweb/Dataverse) - ![GitHub Repo stars](https://img.shields.io/github/stars/multiverseweb/Dataverse) - ![GitHub contributors](https://img.shields.io/github/contributors/multiverseweb/Dataverse) - ![GitHub issues](https://img.shields.io/github/issues/multiverseweb/Dataverse) - ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/multiverseweb/Dataverse) - ![GitHub forks](https://img.shields.io/github/forks/multiverseweb/Dataverse) - ![GitHub pull requests](https://img.shields.io/github/issues-pr/multiverseweb/Dataverse) - ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/multiverseweb/Dataverse) - ![GitHub last commit](https://img.shields.io/github/last-commit/multiverseweb/Dataverse) - ![GitHub repo size](https://img.shields.io/github/repo-size/multiverseweb/Dataverse) - ![GitHub total lines](https://sloc.xyz/github/multiverseweb/Dataverse) - -### Featured In - - - - - - - - - - - - - - - - - -
Event LogoEvent NameEvent Description
GSSoC Ext 24GirlScript Summer of Code Ext 2024GSSOC Ext is a one-month-long open-source program by the GirlScript Foundation that's running from October 1 to November 10, 2024 and encourages participants to contribute to various open source projects.
Hacktoberfest 24Hacktoberfest 2024Hacktober Fest is an annual celebration of open-source software development. It's a month-long event encouraging developers to contribute to open-source projects.
- ---- - -### Table of Contents - -| [About Dataverse](#what-does-this-software-do) | [Versions](#versions) | [Use Dataverse](#deployment-specifications) | [Project Structure](#project-structure) | [Preview](#preview) | [Software Representation](#software-representation) | [Make Contributions](#contributions) | [Website](#website) | -|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| - ---- - -### 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 - -- 6550(24) `Latest` -- 06.02.24 - ---- - -### Deployment Specifications - -Dataverse is currently under development. It will be available for installastion soon. - -However, you can follow these steps to run the project locally on your computer: -> [!IMPORTANT] -> Don't forget to read the [prerequisites](#prerequisites). - - - - Clone the project - - ``` - git clone https://github.com/multiverseweb/Dataverse.git - ``` - - - Open `software` folder in VSCode. - - ``` - cd Dataverse/software - ``` - - - Go to `mainGUI.py` and run it. - -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/)! - ---- - -### Prerequisites -For Data Visualization -- You must have a python interpreter installed on your computer. -- You must have python packages such as `numpy, pandas, matplotlib, tkinter`. - - ``` - pip install package_name - ``` -For Finance Tracker -- 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. -- Also, run the command - ``` - CREATE DATABASE FINANCE; - ``` - on your MySQL workbench or commandline client. - ---- - -### Project Structure - -Check the project structure here [Project Structure](/Documentation/PROJECT_STRUCTURE.md) before Contributing to the repository. - -### 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) - ---- -### 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/script.js#L1-L2) 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 ❀️✨ - -[![Contributors](https://contrib.rocks/image?repo=multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/graphs/contributors) - - -### Stargazers ❀️ - -
- -[![Stargazers repo roster for @multiverseweb/Dataverse](https://reporoster.com/stars/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/stargazers) - - -
- -### Forkers ❀️ - -[![Forkers repo roster for @multiverseweb/Dataverse](https://reporoster.com/forks/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/network/members) - ---- - -### Website - -Deployed on - - - -You can visit the live site for Dataverse and related tools [here](https://multiverse-dataverse.netlify.app/). - - -Back to top - + +# GSSoc'24 Extended + +## Tech Stack + +![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue) +![MySQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white) +![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white) +![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white) +![Matplotlib](https://img.shields.io/badge/Matplotlib-%2311557c.svg?style=for-the-badge&logo=python&logoColor=white) +![Tkinter](https://img.shields.io/badge/Tkinter-blue?style=for-the-badge&logo=python&logoColor=white) +![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white) +![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white) +![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E) +![Microsoft Excel](https://img.shields.io/badge/Microsoft_Excel-217346?style=for-the-badge&logo=microsoft-excel&logoColor=white) + +#### Read the description below and [start contributing](#contributions) now! If you like the project, show some love ❀️ and star the repo! ⭐ + + +--- + +# Dataverse + + +###### Data Visualisation Software & Personal Finance Tracker + + + + +![Visitors](https://api.visitorbadge.io/api/visitors?path=multiverseweb2%2Dataverse%20&countColor=%23263759&style=flat&initial=5767) + ![Github](https://img.shields.io/github/license/multiverseweb/Dataverse) + ![GitHub Repo stars](https://img.shields.io/github/stars/multiverseweb/Dataverse) + ![GitHub contributors](https://img.shields.io/github/contributors/multiverseweb/Dataverse) + ![GitHub issues](https://img.shields.io/github/issues/multiverseweb/Dataverse) + ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/multiverseweb/Dataverse) + ![GitHub forks](https://img.shields.io/github/forks/multiverseweb/Dataverse) + ![GitHub pull requests](https://img.shields.io/github/issues-pr/multiverseweb/Dataverse) + ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/multiverseweb/Dataverse) + ![GitHub last commit](https://img.shields.io/github/last-commit/multiverseweb/Dataverse) + ![GitHub repo size](https://img.shields.io/github/repo-size/multiverseweb/Dataverse) + ![GitHub total lines](https://sloc.xyz/github/multiverseweb/Dataverse) + +### Featured In + + + + + + + + + + + + + + + + + +
Event LogoEvent NameEvent Description
GSSoC Ext 24GirlScript Summer of Code Ext 2024GSSOC Ext is a one-month-long open-source program by the GirlScript Foundation that's running from October 1 to November 10, 2024 and encourages participants to contribute to various open source projects.
Hacktoberfest 24Hacktoberfest 2024Hacktober Fest is an annual celebration of open-source software development. It's a month-long event encouraging developers to contribute to open-source projects.
+ +--- + +### Table of Contents + +| [About Dataverse](#what-does-this-software-do) | [Versions](#versions) | [Use Dataverse](#deployment-specifications) | [Preview](#preview) | [Software Representation](#software-representation) | [Make Contributions](#contributions) | [Website](#website) | +|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + +--- + +### 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 + +- 6550(24) `Latest` +- 06.02.24 + +--- + +### Deployment Specifications + +Dataverse is currently under development. It will be available for installastion soon. + +However, you can follow these steps to run the project locally on your computer: +> [!IMPORTANT] +> Don't forget to read the [prerequisites](#prerequisites). + + + - Clone the project + + ``` + git clone https://github.com/multiverseweb/Dataverse.git + ``` + + - Open `software` folder in VSCode. + + ``` + cd Dataverse/software + ``` + + - Go to `mainGUI.py` and run it. + +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/)! + +--- + +### Prerequisites +For Data Visualization +- You must have a python interpreter installed on your computer. +- You must have python packages such as `numpy, pandas, matplotlib, tkinter`. + + ``` + pip install package_name + ``` +For Finance Tracker +- 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. +- Also, run the command + ``` + CREATE DATABASE FINANCE; + ``` + on your MySQL workbench or commandline client. + +--- +### 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) + +--- +### 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/script.js#L1-L2) 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 ❀️✨ + +[![Contributors](https://contrib.rocks/image?repo=multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/graphs/contributors) + + +### Stargazers ❀️ + +
+ +[![Stargazers repo roster for @multiverseweb/Dataverse](https://reporoster.com/stars/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/stargazers) + + +
+ +### Forkers ❀️ + +[![Forkers repo roster for @multiverseweb/Dataverse](https://reporoster.com/forks/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/network/members) + +--- + +### Website + +Deployed on + + + +You can visit the live site for Dataverse and related tools [here](https://multiverse-dataverse.netlify.app/). + + +Back to top + +======= +# GSSoc'24 Extended + +## Tech Stack + +![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue) +![MySQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white) +![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white) +![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white) +![Matplotlib](https://img.shields.io/badge/Matplotlib-%2311557c.svg?style=for-the-badge&logo=python&logoColor=white) +![Tkinter](https://img.shields.io/badge/Tkinter-blue?style=for-the-badge&logo=python&logoColor=white) +![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white) +![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white) +![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E) +![Microsoft Excel](https://img.shields.io/badge/Microsoft_Excel-217346?style=for-the-badge&logo=microsoft-excel&logoColor=white) + +#### Read the description below and [start contributing](#contributions) now! If you like the project, show some love ❀️ and star the repo! ⭐ + +> [!IMPORTANT] +> Look for issues labeled with and ask for assignment if you can solve them. + +--- + +# Dataverse + + +###### Data Visualisation Software & Personal Finance Tracker + + + + +![Visitors](https://api.visitorbadge.io/api/visitors?path=multiverseweb2%2Dataverse%20&countColor=%23263759&style=flat&initial=5767) + ![Github](https://img.shields.io/github/license/multiverseweb/Dataverse) + ![GitHub Repo stars](https://img.shields.io/github/stars/multiverseweb/Dataverse) + ![GitHub contributors](https://img.shields.io/github/contributors/multiverseweb/Dataverse) + ![GitHub issues](https://img.shields.io/github/issues/multiverseweb/Dataverse) + ![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/multiverseweb/Dataverse) + ![GitHub forks](https://img.shields.io/github/forks/multiverseweb/Dataverse) + ![GitHub pull requests](https://img.shields.io/github/issues-pr/multiverseweb/Dataverse) + ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/multiverseweb/Dataverse) + ![GitHub last commit](https://img.shields.io/github/last-commit/multiverseweb/Dataverse) + ![GitHub repo size](https://img.shields.io/github/repo-size/multiverseweb/Dataverse) + ![GitHub total lines](https://sloc.xyz/github/multiverseweb/Dataverse) + +### Featured In + + + + + + + + + + + + + + + + + +
Event LogoEvent NameEvent Description
GSSoC Ext 24GirlScript Summer of Code Ext 2024GSSOC Ext is a one-month-long open-source program by the GirlScript Foundation that's running from October 1 to November 10, 2024 and encourages participants to contribute to various open source projects.
Hacktoberfest 24Hacktoberfest 2024Hacktober Fest is an annual celebration of open-source software development. It's a month-long event encouraging developers to contribute to open-source projects.
+ +--- + +### Table of Contents + +| [About Dataverse](#what-does-this-software-do) | [Versions](#versions) | [Use Dataverse](#deployment-specifications) | [Project Structure](#project-structure) | [Preview](#preview) | [Software Representation](#software-representation) | [Make Contributions](#contributions) | [Website](#website) | +|:--:|:--:|:--:|:--:|:--:|:--:|:--:|:--:| + +--- + +### 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 + +- 6550(24) `Latest` +- 06.02.24 + +--- + +### Deployment Specifications + +Dataverse is currently under development. It will be available for installastion soon. + +However, you can follow these steps to run the project locally on your computer: +> [!IMPORTANT] +> Don't forget to read the [prerequisites](#prerequisites). + + + - Clone the project + + ``` + git clone https://github.com/multiverseweb/Dataverse.git + ``` + + - Open `software` folder in VSCode. + + ``` + cd Dataverse/software + ``` + + - Go to `mainGUI.py` and run it. + +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/)! + +--- + +### Prerequisites +For Data Visualization +- You must have a python interpreter installed on your computer. +- You must have python packages such as `numpy, pandas, matplotlib, tkinter`. + + ``` + pip install package_name + ``` +For Finance Tracker +- 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. +- Also, run the command + ``` + CREATE DATABASE FINANCE; + ``` + on your MySQL workbench or commandline client. + +--- + +### Project Structure + +Check the project structure here [Project Structure](/Documentation/PROJECT_STRUCTURE.md) before Contributing to the repository. + +### 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) + +--- +### 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/script.js#L1-L2) 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 ❀️✨ + +[![Contributors](https://contrib.rocks/image?repo=multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/graphs/contributors) + + +### Stargazers ❀️ + +
+ +[![Stargazers repo roster for @multiverseweb/Dataverse](https://reporoster.com/stars/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/stargazers) + + +
+ +### Forkers ❀️ + +[![Forkers repo roster for @multiverseweb/Dataverse](https://reporoster.com/forks/dark/multiverseweb/Dataverse)](https://github.com/multiverseweb/Dataverse/network/members) + +--- + +### Website + +Deployed on + + + +You can visit the live site for Dataverse and related tools [here](https://multiverse-dataverse.netlify.app/). + + +Back to top + +