Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added prettier to the project #335

Closed
wants to merge 16 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Handle Automatically line endings depending on the OS
* text=auto
* text eol=lf
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/

software/__pycache__
20 changes: 20 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Ignore the software directory
software/

# Ignore the documentation Directory
Documentation/

# Ignore .vscode directory
.vscode/

# Ignore .github directory
.github/

# Ignore .node_modules directory
node_modules/

# Ignore all .json files
*.json

# Ignore all markdown files
*.md
10 changes: 10 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"printWidth": 100,
"tabWidth": 4,
"semi": true,
"useTabs": true,
"bracketspacing": false,
"arrowParens": "always",
"trailingComma": "none",
"singleQuote": false
}
4 changes: 3 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"liveServer.settings.port": 5502
"liveServer.settings.port": 5502,
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
35 changes: 20 additions & 15 deletions 404.html
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
<!DOCTYPE html>
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Page Not Found :(</title>
<link rel="stylesheet" href="website/styles/404.css">
<link rel="shortcut icon" href="website/web_images/3dlogo.svg" type="image/x-icon">
</head>
<body>
<div class="error404">4<img class="logo" src="website/web_images/2dglow.png" alt="Dataverese's Logo">4</div>
<div class="info">Oops! Page not found.</div>
<div class="info" id="detail">We couldn't find the page you requested. It might be unavailable at the moment or have a different URL.</div>
<a href="index.html" class="home">Return to Home</a>
</body>
</html>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Page Not Found :(</title>
<link rel="stylesheet" href="website/styles/404.css" />
<link rel="shortcut icon" href="website/web_images/3dlogo.svg" type="image/x-icon" />
</head>
<body>
<div class="error404">
4<img class="logo" src="website/web_images/2dglow.png" alt="Dataverese's Logo" />4
</div>
<div class="info">Oops! Page not found.</div>
<div class="info" id="detail">
We couldn't find the page you requested. It might be unavailable at the moment or have a
different URL.
</div>
<a href="index.html" class="home">Return to Home</a>
</body>
</html>
Binary file added Documentation/images/prettier.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,18 @@ Now the software should run locally with no errors, feel free to use the softwar
```
on your MySQL workbench or commandline client.

<highlight>For Website</highlight>
- You must have Node.js installed in your computer, if it is not, install it from [here](https://nodejs.org/en).
- After you have installed it, open the terminal, and run this command to install the required dependencies:
```
npm install
```
- Then, install the Prettier extension in order to format the code consistently accross all devices.

<img src="https://github.com/multiverseweb/Dataverse/blob/main/Documentation/images/prettier.PNG" width="600px">

- After you have installed Prettier, press `Ctrl + Shift + p` to open the Command Palette and type `Reload window` and select the first option to reload, then prettier will be automatically applied.

---

### Repository Structure
Expand Down Expand Up @@ -210,4 +222,4 @@ Want to contribute to this project? Follow these steps:

```

```
```
32 changes: 32 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "dataverse",
"version": "1.0.0",
"description": "![Python](https://img.shields.io/badge/Python-FFD43B?style=for-the-badge&logo=python&logoColor=blue)\r ![MySQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge&logo=mysql&logoColor=white) \r ![NumPy](https://img.shields.io/badge/numpy-%23013243.svg?style=for-the-badge&logo=numpy&logoColor=white)\r ![Pandas](https://img.shields.io/badge/pandas-%23150458.svg?style=for-the-badge&logo=pandas&logoColor=white)\r ![Matplotlib](https://img.shields.io/badge/Matplotlib-%2311557c.svg?style=for-the-badge&logo=python&logoColor=white)\r ![Tkinter](https://img.shields.io/badge/Tkinter-blue?style=for-the-badge&logo=python&logoColor=white) \r ![HTML5](https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white) \r ![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)\r ![JavaScript](https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E) \r ![Microsoft Excel](https://img.shields.io/badge/Microsoft_Excel-217346?style=for-the-badge&logo=microsoft-excel&logoColor=white)",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "Tejas Gupta",
"license": "MIT",
"devDependencies": {
"prettier": "3.3.3"
}
}
Binary file modified plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified software/__pycache__/financeTracker.cpython-311.pyc
Binary file not shown.
Binary file removed software/__pycache__/functions.cpython-311.pyc
Binary file not shown.
Binary file removed software/__pycache__/main.cpython-311.pyc
Binary file not shown.
Binary file removed software/__pycache__/mainGUI.cpython-311.pyc
Binary file not shown.
Binary file removed software/__pycache__/plot.cpython-311.pyc
Binary file not shown.
Binary file removed software/__pycache__/report.cpython-311.pyc
Binary file not shown.
Loading