1
0
mirror of https://github.com/upscayl/upscayl.git synced 2024-11-12 01:40:53 +01:00

add sections to development

This commit is contained in:
Aaron Liu 2023-09-18 15:20:14 -04:00 committed by GitHub
parent 09ec3ff3e6
commit 35705257f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -110,8 +110,11 @@ You can track all the progress here: https://github.com/orgs/upscayl/projects/1
I recommend using Volta: https://volta.sh for installing Node.js.
Download and install volta, then do: `volta install node`.
You can also use pnpm instead.
```bash
## 🏃 Running
```sh
# FOR EVERYONE
git clone https://github.com/upscayl/upscayl
cd upscayl
@ -122,12 +125,19 @@ npm install
# RUN THE DEVELOPMENT SERVER LOCALLY
## YOUR LOGS WILL NOW APPEAR IN THE TERMINAL
npm run dev
```
## 🏗️ Building
```
# FOR DEVS
## PACKAGE THE APP
# INSTALL DEPENDENCIES
npm install
# PACKAGE THE APP
npm run dist
## PUBLISH THE APP, MAKE SURE TO ADD GH_TOKEN= IN SHELL
# PUBLISH THE APP, MAKE SURE TO ADD GH_TOKEN= IN SHELL
npm run publish-app
```