{"id":18378130,"url":"https://github.com/jieyouxu/vrme-server-rust","last_synced_at":"2025-06-16T21:38:22.953Z","repository":{"id":37180165,"uuid":"242176672","full_name":"jieyouxu/VRME-Server-Rust","owner":"jieyouxu","description":"VRME server written in Rust.","archived":false,"fork":false,"pushed_at":"2023-01-20T22:27:42.000Z","size":36055,"stargazers_count":0,"open_issues_count":17,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-06T00:39:37.648Z","etag":null,"topics":["rest-api","rust"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jieyouxu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-21T15:58:28.000Z","updated_at":"2020-04-05T19:55:05.000Z","dependencies_parsed_at":"2023-02-12T06:15:18.321Z","dependency_job_id":null,"html_url":"https://github.com/jieyouxu/VRME-Server-Rust","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jieyouxu%2FVRME-Server-Rust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jieyouxu%2FVRME-Server-Rust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jieyouxu%2FVRME-Server-Rust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jieyouxu%2FVRME-Server-Rust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jieyouxu","download_url":"https://codeload.github.com/jieyouxu/VRME-Server-Rust/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231051127,"owners_count":18320577,"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":["rest-api","rust"],"created_at":"2024-11-06T00:31:28.764Z","updated_at":"2024-12-24T04:40:54.848Z","avatar_url":"https://github.com/jieyouxu.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Virtual Reality Meeting Environment Backend Server\n\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/jieyouxu/VRME-Server-Rust?logo=GitHub\u0026style=flat-square)\n![GitHub](https://img.shields.io/github/license/jieyouxu/VRME-Server-Rust?style=flat-square)\n![GitHub deployments](https://img.shields.io/github/deployments/jieyouxu/VRME-Server-Rust/github-pages?label=documentation%20deployment\u0026logo=GitHub\u0026style=flat-square)\n\n## Development\n\nThe project is written in [Rust](https://github.com/rust-lang/rust). It is\nwritten in Rust Edition `2018`, using the latest stable release.\n\n- We use [Cargo](https://github.com/rust-lang/cargo/) for the package manager.\n- We use [rustup](https://github.com/rust-lang/rustup/) for managing the tool\n  chain.\n- We use [mdBook](https://github.com/rust-lang/mdBook) for API endpoint\n  documentation.\n- We use [rustfmt](https://github.com/rust-lang/rustfmt) for formatting Rust\n  source code.\n\nThe actual Rust project is under `vrme_server`, so start by changing the working\ndirectory into `vrme_server`:\n\n```bash\ncd vrme_server\n```\n\nAll of the instructions below assume that you are under the `vrme_server`\ndirectory already.\n\n### Code Documentation\n\nIf you want to generate and render code documentation for `vrme_server`, run\n\n```bash\ncargo doc\n```\n\nAnd the docs will be generated under `target/doc`.\n\n- If you wish to open the documentation in the browser directly, run instead\n  (the browser executable pointed to by `$BROWSER`):\n\n   ```bash\n   cargo doc --open\n   ```\n\n- If you don't want to generate docs for dependency crates, specify the\n  `--no-deps` flag to `cargo doc`\n\n   ```bash\n   cargo doc --no-deps --open\n   ```\n\n## API Documentation\n\nAvailable at\n[VRME-API-Documentation](https://github.com/jieyouxu/VRME-API-Documentation).\n\n## Logging Level\n\nTo specify the logging level, provide `LOG` with one of:\n\n| Verbosity     | `LOG=`  |\n|---------------|---------|\n| Most verbose  | `TRACE` |\n|               | `DEBUG` |\n|               | `INFO`  |\n|               | `WARN`  |\n| Least verbose | `ERROR` |\n\n`LOG=INFO` is the default logging level.\n\nExample log level setting:\n\n```\nLOG=WARN RUN_MODE=production cargo run --release\n```\n\n## Configuration\n\nRun the application in either development mode or production mode by specifying\n`RUN_MODE`:\n\n- **Production** mode:\n\n    ```bash\n    RUN_MODE=production cargo run --release\n    ```\n\n    *The `--release` flag passed to `cargo` enables `-O3` optimization by\n    default which is suitable for production mode, but erases useful debugging\n    information for development.*\n\n- **Development** mode:\n\n    ```bash\n    RUN_MODE=development cargo run\n    ```\n\nThe server will:\n\n1. Read from a base (shared) configuration file:\n\n    ```bash\n    # Copy example default configuration\n    cp config/default.example.toml config/default.toml\n    ```\n\n2. Read from a `RUN_MODE`-dependent configuration file.\n\n    Change `$RUN_MODE` below to either `production` or `development`.\n\n    ```bash\n    # Copy example $RUN_MODE-dependent configuration\n    cp config/$RUN_MODE.example.toml config/$RUN_MODE.toml\n    ```\n\n3. Read from environment variables that have the same key name as the ones in\n   the configuration file. The environment variables need to be *prefixed* by\n   `APP_`. When the configuration is nested, such as `server.hostname`, use the\n   separator `__` to replace the dot as the name of the environment variable.\n\n   *Example: `server.hostname` is overriden by `APP_SERVER__HOSTNAME`*.\n\n   ```bash\n   # Override `server.hostname`\n   APP_SERVER__HOSTNAME=127.0.0.1 \\\n       RUN_MODE=development \\\n       cargo run\n   ```\n\nEnvironment variables take precedence over `RUN_MODE`-specific configuration\nfiles, which in turn take precedence over the default shared configuration\nfile.\n\nSee the `src/settings` module for the most accurate configuration options.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjieyouxu%2Fvrme-server-rust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjieyouxu%2Fvrme-server-rust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjieyouxu%2Fvrme-server-rust/lists"}