Skip to content

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
124 changes: 124 additions & 0 deletions GETTING_STARTED.md
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
Copy link
Member

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)

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.

25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,12 @@ We would love to hear from you! We communicate on Slack:

[![Slack](https://img.shields.io/badge/chat-on_slack-purple.svg?style=for-the-badge&logo=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.
Copy link
Member

Choose a reason for hiding this comment

The 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.
Expand Down Expand Up @@ -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**