Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jieyouxu/vrme-server-rust
VRME server written in Rust.
https://github.com/jieyouxu/vrme-server-rust
rest-api rust
Last synced: 3 days ago
JSON representation
VRME server written in Rust.
- Host: GitHub
- URL: https://github.com/jieyouxu/vrme-server-rust
- Owner: jieyouxu
- License: mit
- Created: 2020-02-21T15:58:28.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T22:27:42.000Z (almost 2 years ago)
- Last Synced: 2024-11-06T00:39:37.648Z (about 2 months ago)
- Topics: rest-api, rust
- Language: Rust
- Size: 34.4 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Virtual Reality Meeting Environment Backend Server
## Development
The project is written in [Rust](https://github.com/rust-lang/rust). It is
written in Rust Edition `2018`, using the latest stable release.
- We use [Cargo](https://github.com/rust-lang/cargo/) for the package manager.
- We use [rustup](https://github.com/rust-lang/rustup/) for managing the tool
chain.
- We use [mdBook](https://github.com/rust-lang/mdBook) for API endpoint
documentation.
- We use [rustfmt](https://github.com/rust-lang/rustfmt) for formatting Rust
source code.
The actual Rust project is under `vrme_server`, so start by changing the working
directory into `vrme_server`:
```bash
cd vrme_server
```
All of the instructions below assume that you are under the `vrme_server`
directory already.
### Code Documentation
If you want to generate and render code documentation for `vrme_server`, run
```bash
cargo doc
```
And the docs will be generated under `target/doc`.
- If you wish to open the documentation in the browser directly, run instead
(the browser executable pointed to by `$BROWSER`):
```bash
cargo doc --open
```
- If you don't want to generate docs for dependency crates, specify the
`--no-deps` flag to `cargo doc`
```bash
cargo doc --no-deps --open
```
## API Documentation
Available at
[VRME-API-Documentation](https://github.com/jieyouxu/VRME-API-Documentation).
## Logging Level
To specify the logging level, provide `LOG` with one of:
| Verbosity | `LOG=` |
|---------------|---------|
| Most verbose | `TRACE` |
| | `DEBUG` |
| | `INFO` |
| | `WARN` |
| Least verbose | `ERROR` |
`LOG=INFO` is the default logging level.
Example log level setting:
```
LOG=WARN RUN_MODE=production cargo run --release
```
## Configuration
Run the application in either development mode or production mode by specifying
`RUN_MODE`:
- **Production** mode:
```bash
RUN_MODE=production cargo run --release
```
*The `--release` flag passed to `cargo` enables `-O3` optimization by
default which is suitable for production mode, but erases useful debugging
information for development.*
- **Development** mode:
```bash
RUN_MODE=development cargo run
```
The server will:
1. Read from a base (shared) configuration file:
```bash
# Copy example default configuration
cp config/default.example.toml config/default.toml
```
2. Read from a `RUN_MODE`-dependent configuration file.
Change `$RUN_MODE` below to either `production` or `development`.
```bash
# Copy example $RUN_MODE-dependent configuration
cp config/$RUN_MODE.example.toml config/$RUN_MODE.toml
```
3. Read from environment variables that have the same key name as the ones in
the configuration file. The environment variables need to be *prefixed* by
`APP_`. When the configuration is nested, such as `server.hostname`, use the
separator `__` to replace the dot as the name of the environment variable.
*Example: `server.hostname` is overriden by `APP_SERVER__HOSTNAME`*.
```bash
# Override `server.hostname`
APP_SERVER__HOSTNAME=127.0.0.1 \
RUN_MODE=development \
cargo run
```
Environment variables take precedence over `RUN_MODE`-specific configuration
files, which in turn take precedence over the default shared configuration
file.
See the `src/settings` module for the most accurate configuration options.