-
Notifications
You must be signed in to change notification settings - Fork 153
docs: add Getting Started guide and update prerequisites for CircuiVerse (desktop tauri setup) #598
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
Open
blazethunderstorm
wants to merge
3
commits into
CircuitVerse:main
Choose a base branch
from
blazethunderstorm:docc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
<div align="center"> <img src="https://github.com/CircuitVerse/CircuitVerse/raw/master/app/assets/images/cvlogo.svg" alt="CircuitVerse Logo" width="320"/> </div> | ||
|
||
|
||
# Getting Started - CircuitVerse Frontend Vue | ||
|
||
Welcome to the CircuitVerse Frontend Vue project! This guide will help you set up the project for both web development and desktop application development using Tauri. | ||
|
||
## Prerequisites | ||
Before setting up the project, ensure you have the following installed: | ||
|
||
### For Web Development | ||
- **Node.js** (version 16 or higher) | ||
- **npm** (comes with Node.js) | ||
|
||
### For Desktop Application Development (Tauri) | ||
- **Rust** - Required for Tauri desktop app development | ||
- **System Dependencies** - Platform-specific requirements for Tauri | ||
|
||
#### Installing Rust | ||
1. Visit [rustup.rs](https://rustup.rs/) or run the following command: | ||
```bash | ||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh | ||
``` | ||
2. Follow the installation prompts | ||
3. Restart your terminal or run: | ||
```bash | ||
source ~/.cargo/env | ||
``` | ||
4. Verify installation: | ||
```bash | ||
rustc --version | ||
cargo --version | ||
``` | ||
|
||
#### Platform-Specific Dependencies | ||
|
||
**Windows:** | ||
- Microsoft Visual Studio C++ Build Tools or Visual Studio Community | ||
- WebView2 (usually pre-installed on Windows 10/11) | ||
|
||
**macOS:** | ||
- Xcode Command Line Tools: | ||
```bash | ||
xcode-select --install | ||
``` | ||
|
||
**Linux (Ubuntu/Debian):** | ||
```bash | ||
sudo apt update | ||
sudo apt install libwebkit2gtk-4.0-dev \ | ||
build-essential \ | ||
curl \ | ||
wget \ | ||
file \ | ||
libssl-dev \ | ||
libgtk-3-dev \ | ||
libayatana-appindicator3-dev \ | ||
librsvg2-dev | ||
``` | ||
|
||
**Linux (Fedora):** | ||
```bash | ||
sudo dnf install webkit2gtk4.0-devel \ | ||
openssl-devel \ | ||
curl \ | ||
wget \ | ||
file \ | ||
libappindicator-gtk3-devel \ | ||
librsvg2-devel | ||
sudo dnf group install "C Development Tools and Libraries" | ||
``` | ||
|
||
**Linux (Arch):** | ||
```bash | ||
sudo pacman -S webkit2gtk \ | ||
base-devel \ | ||
curl \ | ||
wget \ | ||
file \ | ||
openssl \ | ||
appmenu-gtk-module \ | ||
gtk3 \ | ||
libappindicator-gtk3 \ | ||
librsvg \ | ||
libvips | ||
``` | ||
|
||
## Installation | ||
To set up the project on your local machine, follow these steps: | ||
|
||
1. Clone the repository to your local machine using the following command: | ||
``` | ||
git clone https://github.com/CircuitVerse/cv-frontend-vue.git | ||
``` | ||
2. Navigate to the project directory: | ||
``` | ||
cd cv-frontend-vue | ||
``` | ||
3. Install the project dependencies: | ||
``` | ||
npm install | ||
``` | ||
4. Start the development server: | ||
``` | ||
npm run dev | ||
``` | ||
|
||
## Desktop Application Development (Tauri) | ||
For working with the desktop application version: | ||
|
||
### Development Mode | ||
To run the desktop application in development mode: | ||
```bash | ||
npm run tauri dev | ||
``` | ||
|
||
### Building the Desktop Application | ||
To build the desktop application for production: | ||
```bash | ||
npm run tauri build | ||
``` | ||
|
||
The built application will be available in the `src-tauri/target/release/bundle/` directory. | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,25 +10,12 @@ We would love to hear from you! We communicate on Slack: | |
|
||
[](https://circuitverse.org/slack) | ||
|
||
## Installation | ||
To set up the project on your local machine, follow these steps: | ||
|
||
1. Clone the repository to your local machine using the following command: | ||
``` | ||
git clone https://github.com/CircuitVerse/cv-frontend-vue.git | ||
``` | ||
2. Navigate to the project directory: | ||
``` | ||
cd cv-frontend-vue | ||
``` | ||
3. Install the project dependencies: | ||
``` | ||
npm install | ||
``` | ||
4. Start the development server: | ||
``` | ||
npm run dev | ||
``` | ||
## Development | ||
|
||
To get started, please refer to [`GETTING_STARTED.md`](https://github.com/blazethunderstorm/cv-frontend-vue/blob/docc/GETTING_STARTED.md) for full setup instructions. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can't give link to your docs, change the link to what wud be the link when PR gets merged |
||
|
||
|
||
|
||
## 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. | ||
|
@@ -71,4 +58,4 @@ This project is licensed under the [MIT License](LICENSE). | |
2. **Testing and bug fixing** | ||
3. **Typescript integration & style Refactoring** | ||
4. **Creating the desktop application** | ||
5. **Removing JQuery** | ||
5. **Removing JQuery** |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are no statements below this intentional? if not then remove this point (kinda mundane)