App Quick Start Guide
# Clone this repository
git clone --recurse-submodules https://github.com/webaverse/app.git
# Go into the repository
# Install dependencies
# Run the app
npm run start
# Navigate to the URL mentioned in the terminal
When cloning App from git, you must include the option "--recurse-submodules". The App repo relies upon and imports other Webaverse repos that are vital to the functioning application.
Development Environment Setup
We prefer using VSCode for development, so the below notes reflect that toolset; however you should be able to adapt this guide to apply to any other IDEs.
The App primarily uses the following technologies
├───src <--- React Application Resides Here
├───Main.jsx <-- Rgisters the routes of the React App and Load Dom
├───App.jsx <-- Loads Webaverse.js from Root directory
├─ index.js <-- This starts the vite server that serves the React App
├─ webaverse.js <-- This is the entry point of the Webaverse
├─ io-manager.js <-- Controls the input events within the application.
To setup ESLint, refer to: Quick Start Basics
The application uses Vite to hot reload itself automatically if there are any changes to any files. To start the App in dev mode, run:
npm run start
Any changes inside the
packages folder won't recompile automatically and so will require restarting the entire development server by just running again:
npm run dev