https://github.com/vircadia/vircadia-user-docs
https://github.com/vircadia/vircadia-user-docs
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vircadia/vircadia-user-docs
- Owner: vircadia
- License: apache-2.0
- Archived: true
- Created: 2022-09-07T12:00:49.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-04T07:21:38.000Z (over 2 years ago)
- Last Synced: 2025-03-21T19:48:55.727Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://docs.vircadia.com/
- Size: 28.8 MB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vircadia User Documentation
User documentation for the Vircadia open source metaverse ecosystem.
### 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
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER= 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.