Lighthouse is the world's leading open metaverse navigation engine. Find friends, travel, and socialize in the spatial web.
This mono repo contains the three main services of Lighthouse's backend:
- Discovery API: Responsible for serving data to the app, allowing them to discover what's happening across the different worlds.
- User API: Responsible for everything tied to users and their interactions with worlds and amongst each other.
- Content Gatherer: Responsible for getting data from external sources and storing it in the Lighthouse data stores.
We welcome contributions to Lighthouse! Please see our contributing guidelines for more information.
To run, Lighthouse requires a valid GCP environment and subscriptions to different third parties.
- Node 20 (e.g. via nvm)
- git clone git@github.com:lighthouse-xyz/server.git
- Install dependencies
- Create a .env.local file by copying .env.local.sample
- Fill in the .env.local file with the missing credentials
- Run
npm run start:devto start the server
