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.

Sign up for GitHub

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

docs: add desktop development commands to README.md #527

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add desktop development commands to README.md #527

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,26 @@ To set up the project on your local machine, follow these steps:
npm run dev
```

## Desktop Application Development
> **Note**: Desktop application support is currently a planned feature (see To-Dos item #4).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need to add note for now

This section provides preliminary information for future desktop application development using tauri framework.

### Prerequisites (Planned)
- Node.js v16 or higher
- npm v8 or higher
- Desktop application framework (Tauri)
Comment on lines +37 to +40
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tauri only have prerequisites rust and cargo, move node and npm to prerequisites to web app


### Future Implementation
Once desktop application support is added, the following workflow is anticipated:
Comment on lines +42 to +43
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove


```bash
# Run desktop app in development mode
npm run tauri dev

# Build desktop application
npm run tauri build
```

## Setting up on cloud with Stackblitz
[StackBlitz](https://developer.stackblitz.com/guides/user-guide/what-is-stackblitz) is an instant fullstack web IDE for the JavaScript ecosystem.

Expand Down