{"id":21858568,"url":"https://github.com/vircadia/vircadia-metaverse","last_synced_at":"2025-04-05T18:09:44.270Z","repository":{"id":38276511,"uuid":"280182715","full_name":"vircadia/vircadia-metaverse","owner":"vircadia","description":"Metaverse server for Vircadia","archived":false,"fork":false,"pushed_at":"2025-01-29T09:35:10.000Z","size":1535,"stargazers_count":59,"open_issues_count":43,"forks_count":55,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-29T16:06:48.308Z","etag":null,"topics":["metaverse","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://vircadia.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vircadia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-16T14:58:24.000Z","updated_at":"2025-01-29T09:34:54.000Z","dependencies_parsed_at":"2025-02-20T06:11:18.447Z","dependency_job_id":"a520ade2-22db-48a9-ab91-9e93a5066eaf","html_url":"https://github.com/vircadia/vircadia-metaverse","commit_stats":null,"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-metaverse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-metaverse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-metaverse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vircadia%2Fvircadia-metaverse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vircadia","download_url":"https://codeload.github.com/vircadia/vircadia-metaverse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247378149,"owners_count":20929297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["metaverse","nodejs","typescript"],"created_at":"2024-11-28T02:46:23.986Z","updated_at":"2025-04-05T18:09:44.247Z","avatar_url":"https://github.com/vircadia.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vircaida Metaverse\r\n\r\n## Getting Started\r\n\r\n1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.\r\n\r\n2. Install docker (https://docs.docker.com/engine/install)\r\n\r\n3. Go to the project root path.\r\n\r\n4. Install Ethereum DLT dependencies (optional)\r\n\r\n    ```sh\r\n    cd ethereum/dlt/\r\n    npm install\r\n    cd ..\r\n    ```\r\n\r\n5. Open `conf.d/vircadia_conf.conf` file and change the `server_name`\r\n\r\n6. Create the `.env` file.\r\n    ```sh\r\n     cp env.default .env\r\n    ```\r\n7. Open the `.env` file and change following:\r\n\r\n    ```\r\n    SERVER_HOST,\r\n    METAVERSE_SERVER_URL,\r\n    DEFAULT_ICE_SERVER_URL,\r\n    DASHBOARD_URL,\r\n    APP_LOGO,\r\n    APP_URL,\r\n    SMTP_USER,\r\n    SMTP_PASS,\r\n    SMTP_EMAIL_FROM\r\n    # Handle any other params you want to change\r\n\r\n    # Blockchain params (optional)\r\n\r\n    MINTER_PRIVATE_KEY,\r\n    ETH_RPC_URL\r\n    ```\r\n\r\n### Run with Docker\r\n\r\nRun the following commands to deploy with Docker:\r\n\r\n```sh\r\ndocker compose build\r\ndocker compose up -d\r\n```\r\n\r\nTo stop the containers, run the following command:\r\n\r\n```sh\r\ndocker compose down\r\n```\r\n\r\nTo clean up the containers, run the following command:\r\n\r\n```sh\r\ndocker rmi $(docker images --filter \"dangling=true\" -q --no-trunc)\r\n```\r\n\r\n## Testing\r\n\r\nRun `npm test` and all your tests in the `test/` directory will be run.\r\n\r\n_Note: DLT is not a required component for the metaverse._\r\n\r\nSpin up a test chain:\r\n\r\n`npm run localchain`\r\n\r\n## Scaffolding\r\n\r\nFeathers has a powerful command line interface. Here are a few things it can do:\r\n\r\n````\r\n\r\n$ npm install -g @feathersjs/cli # Install Feathers CLI\r\n\r\n$ feathers generate service # Generate a new Service\r\n$ feathers generate hook # Generate a new Hook\r\n$ feathers help # Show all commands\r\n\r\n```\r\n\r\n## Generate Doc\r\n\r\n```\r\n\r\nnpx typedoc expand ./src/services/\\*_/_.class.ts\r\n\r\n```\r\n\r\n```\r\n````\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvircadia%2Fvircadia-metaverse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvircadia%2Fvircadia-metaverse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvircadia%2Fvircadia-metaverse/lists"}