diff --git a/package.json b/package.json index 19e93c1..120d8d8 100644 --- a/package.json +++ b/package.json @@ -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/", diff --git a/readme.md b/readme.md index 304ac12..72c44d6 100644 --- a/readme.md +++ b/readme.md @@ -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) @@ -26,7 +26,7 @@ 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 @@ -34,12 +34,21 @@ 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.