https://github.com/vircadia/vircadia-dev-docs
Developer documentation for the Vircadia open source metaverse.
https://github.com/vircadia/vircadia-dev-docs
Last synced: about 1 year ago
JSON representation
Developer documentation for the Vircadia open source metaverse.
- Host: GitHub
- URL: https://github.com/vircadia/vircadia-dev-docs
- Owner: vircadia
- License: apache-2.0
- Created: 2021-05-20T10:04:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-16T05:26:05.000Z (over 1 year ago)
- Last Synced: 2025-03-28T07:22:31.068Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://docs.vircadia.dev
- Size: 2.9 MB
- Stars: 3
- Watchers: 3
- Forks: 18
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vircadia Developer Documentation
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ GIT_USER= USE_SSH=true yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
### Cloning with Submodules
To clone this repository including all submodules, use the following command:
```sh
git clone --recursive https://github.com/vircadia/vircadia-dev-docs.git
```
If you forgot to clone with the submodules, you can initialize and update them with:
```sh
git submodule update --init --recursive
```