You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Supports all data visualisation techniques, basic as well as advanced.
66
-
- Generates interactive, customizable and exportable graphs.
67
-
- Provides data storage for later use.
68
-
- Supports data inputs from excel sheets.
69
-
- Simplifies expense tracking and financial management.
70
-
- Allows user to download financial reports.
67
+
- This software can be used to visualise data in many basic as well as advanced forms.
68
+
- It allows the user to download the generated charts.
69
+
- It can be used as a finance tracker, providing various useful outputs.
70
+
- It supports data inputs from excel sheets.
71
+
- The data can also be stored for later use.
71
72
- Uses encryption techniques to securely store your passwords.
72
-
- View and manage data via a mobile-friendly website.
73
-
- Provides predictive analytics and trend analysis using ML techniques.
74
73
75
74
---
75
+
### Versions
76
+
77
+
- v.XM45'24 Under Development
78
+
- v.6550(24) Latest
79
+
- v.06.02.24
80
+
81
+
---
82
+
83
+
### Prerequisites
84
+
<highlight>For Data Visualization</highlight>
85
+
- Ensure that a Python interpreter is installed on your computer. If not, download it from [ Python's official website](https://www.python.org/downloads/).
86
+
87
+
<highlight>For Finance Tracker</highlight>
88
+
- Install MySQL on your computer. If you don't have it, you can download it from [here](https://dev.mysql.com/downloads/installer/).
2. **Create a Virtual Environment (optional but recommended)**
100
+
- On Windows:
101
+
102
+
```
103
+
python -m venv venv
104
+
venv\Scripts\activate
105
+
```
106
+
107
+
- On macOS/Linux:
108
+
109
+
```
110
+
python3 -m venv venv
111
+
source venv/bin/activate
112
+
```
113
+
114
+
3. **Navigate to the Project's software Directory**
115
+
116
+
```
117
+
cd Dataverse/software
118
+
```
119
+
120
+
4. **Install Dependencies**
121
+
122
+
- Install all the required Python packages using `requirements.txt`:
123
+
124
+
```
125
+
pip install -r ../installation/requirements.txt
126
+
```
127
+
128
+
5. **Finance Tracker Setup**
129
+
130
+
- 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`).
131
+
- Also, run the command
132
+
```
133
+
CREATE DATABASE DATAVERSE;
134
+
```
135
+
on your MySQL workbench or commandline client.
136
+
137
+
6. **Run the Project**
138
+
139
+
- Run main.py using the command:
140
+
141
+
```
142
+
python main.py
143
+
```
144
+
145
+
- Alternatively, open `main.py` in VSCode and run it.
146
+
147
+
7. **Deactivate the Virtual Environment**
148
+
149
+
- After you’re done working with the project, you can deactivate the virtual environment:
150
+
151
+
```
152
+
deactivate
153
+
```
154
+
155
+
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/)!
| 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. |
107
-
| v.6550.24 `Latest`| Current stable version that supports most of the data visualisation techniques and finance tracking. Major development done during GSSoC'24. |
108
-
| v.06.02.24 | Initial version developed on 6th February, 2024. Only supports finance tracking. |
III. Install MySQL if you don't have it already from [here](https://dev.mysql.com/downloads/installer/).
135
-
136
-
> [!IMPORTANT]
137
-
> 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.
138
-
139
-
IV. Run the application:
140
-
141
-
> ```
142
-
> python software/main.py
143
-
> ```
185
+
### Software Representation
186
+
<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
144
187
145
-
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/)!
188
+
ER Diagram for Finance Tracker
189
+
146
190
147
191
---
148
192
@@ -168,30 +212,38 @@ Now, the software should run smoothly with no errors, feel free to use the softw
168
212
/>
169
213
</picture>
170
214
171
-
---
172
-
173
215
### Contributions
216
+
<sup><a href="#table-of-contents" align="right">Back to top</a></sup>
174
217
175
-
Want to make contributions to this project? ✨
218
+
Want to contribute to this project? Follow these steps:
- Go to [issues](https://github.com/multiverseweb/Dataverse/issues), find an issue that you can solve or create a new issue.
222
+
- Fork the repository.
223
+
- Create a new branch (git checkout -b feature-branch).
224
+
- 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)
225
+
- Make your contributions and commit them (git commit -m 'Add feature').
226
+
- Push to the branch (git push origin feature-branch).
227
+
- Create a Pull Request, so I can review and merge it.
[](https://github.com/multiverseweb/Dataverse/stargazers)
191
242
243
+
192
244
</div>
193
245
194
-
### Forkers 🍴
246
+
### Forkers ❤
195
247
196
248
[](https://github.com/multiverseweb/Dataverse/network/members)
197
249
@@ -201,8 +253,5 @@ Want to make contributions to this project? ✨
0 commit comments