Skip to content
This repository has been archived by the owner on Feb 26, 2025. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mauriciabad committed Jan 13, 2024
1 parent 2d98c50 commit aa7ca9a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"scripts": {
"test": "jest",
"predist": "rm -rf dist/* && touch dist/.gitkeep",
"dev": "gulp watch",
"dist": "run-p dist:*",
"dist:assets": "gulp assets",
"dist:_redirects": "cp src/_redirects dist/",
Expand Down
19 changes: 14 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

# GradeCalc

[GradeCalc](https://gradecalc.mauri.app) is a progressive web app for students, it's main porpouse is calculating the necessary mark in the remaining exams to pass a subject.
[GradeCalc](https://gradecalc.mauri.app) is a progressive web app for students, its main purpose is to calculate the necessary mark in the remaining exams to pass a subject.

You can create your own subject and share it, or if someone created it before, you can use theirs.

Also, it allows you to login with Google and store your subjects in the cloud, so you can acces them from yout mobile and pc.
Also, it allows you to login with Google and store your subjects in the cloud, so you can access them from your mobile and pc.

Use it here: [gradecalc.mauri.app](https://gradecalc.mauri.app)

Expand All @@ -26,20 +26,29 @@ Use it here: [gradecalc.mauri.app](https://gradecalc.mauri.app)

### Setup

Use this command to insatll all dependencies.
Use this command to install all dependencies.

```bash
npm i
```

### Develop

Use this command to compile the js and css when you save the files.
First, install dependencies and build the app:

```bash
gulp watch
npm i
npm run dist
```

Use this command to compile the JS and CSS when you save the files.

```bash
npm run dev
```

Finally, serve the `dist` folder to view the changes.

### Build

Use this command to compile all the files to the `dist/` directory.
Expand Down

0 comments on commit aa7ca9a

Please sign in to comment.