Github

1.1 Register an Account

The VisActor team usually develops and maintains issues on Github. Please open the Github website, click the Sign up button in the top right corner, register your own account, and take the first step on your open-source journey.

If, due to special circumstances, you are unable to access the Github site, please inform us and proceed with project development through Gitee.

1.2 Fork the Project

First, you need to fork this project. Go to the VRender project page and click the Fork button in the top right corner.

Your github account will show the project xxxx(your github username)/vrender.

Local Development Environment

2.1 Install Git

Since the code is hosted on Github, we use git for version control.

Git is a version control system used to track and manage code changes in software development projects. It helps developers record and manage the history of code, facilitating team collaboration, code version control, code merging, and other operations. With Git, you can track every version of each file and easily switch and compare between different versions. Git also provides branch management functionality, allowing multiple parallel development tasks to be carried out simultaneously.

Visit the Git official website: https://git-scm.com/
Download the latest version of the Git installer.
Run the downloaded installer and follow the installation wizard instructions.
After installation, you can confirm the successful installation by using the git version command in the command line.

git version
**git version 2.39.2 (Apple Git-143)**

2.2 Install Development Tools (Recommended: VSCode)

VisActor is mainly in the front-end technology stack, and there are many tools available for front-end development. We recommend using VSCode. Of course, you can also use your preferred development tool.

If you are not familiar with VSCode, it is recommended to read the official documentation: https://vscode.js.cn/docs/setup/setup-overview

2.3 Install Marscode AI Programming Assistant

Marscode AI Programming Assistant

Marscode AI Programming Assistant is an AI programming assistant provided by Marscode, offering AI features such as intelligent code completion. It supports mainstream programming languages and IDEs, providing suggestions for writing single lines of code or entire functions during development. Additionally, it supports functions such as code interpretation, unit test generation, and issue fixing, improving development efficiency and quality. For more information, please refer to the documentation of Marscode AI Programming Assistant.

With Marscode, VisActor developers can more conveniently perform tasks such as code understanding, document writing, feature development, and unit testing. Detailed examples will be provided in the contribution guidelines for various tasks.

2.4 Clone the Code to Local

Navigate to the VRender folder and add the remote address of VRender.

git remote add upstream https://github.com/VisActor/VRender.git

Get the latest source code of VRender.

git pull upstream develop

Initialize the Project

First, globally install @microsoft/rush

$ npm i --global @microsoft/rush

Next, run the command to view the demo.

# Install dependencies
$ rush update
# Start the demo page of vrender
$ rush run -p @visactor/vrender -s start
# Start the local document site
$ rush docs