Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/revoltchat/backend
Monorepo for Revolt backend services.
https://github.com/revoltchat/backend
api mongodb redis revolt rust
Last synced: 20 days ago
JSON representation
Monorepo for Revolt backend services.
- Host: GitHub
- URL: https://github.com/revoltchat/backend
- Owner: revoltchat
- License: other
- Created: 2021-06-15T13:11:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T16:22:48.000Z (about 1 month ago)
- Last Synced: 2024-10-01T19:07:52.038Z (about 1 month ago)
- Topics: api, mongodb, redis, revolt, rust
- Language: Rust
- Homepage: https://developers.revolt.chat/api/
- Size: 2.98 MB
- Stars: 1,137
- Watchers: 15
- Forks: 125
- Open Issues: 89
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust - Revolt/backend - User-first chat platform built with modern web technologies. (Applications / Web)
- awesome-rust-cn - Revolt/backend - 用现代网络技术建立的用户至上的聊天平台. (应用程序 Applications / 网络 Web)
- awesome-rust - Revolt/backend - User-first chat platform built with modern web technologies. (Applications / Web)
- fucking-awesome-rust - Revolt/backend - User-first chat platform built with modern web technologies. (Applications / Web)
- fucking-awesome-rust - Revolt/backend - User-first chat platform built with modern web technologies. (Applications / Web)
README
Revolt Backend
[](https://github.com/revoltchat/backend/stargazers)
[](https://github.com/revoltchat/backend/network/members)
[](https://github.com/revoltchat/backend/pulls)
[](https://github.com/revoltchat/backend/issues)
[](https://github.com/revoltchat/backend/graphs/contributors)
[](https://github.com/revoltchat/backend/blob/main/LICENSE)
The services and libraries that power the Revolt service.
| Crate | Path | Description | |
| ------------------ | -------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `core/config` | [crates/core/config](crates/core/config) | Core: Configuration |     |
| `core/database` | [crates/core/database](crates/core/database) | Core: Database Implementation |     |
| `core/files` | [crates/core/files](crates/core/files) | Core: S3 and encryption subroutines |     |
| `core/models` | [crates/core/models](crates/core/models) | Core: API Models |     |
| `core/permissions` | [crates/core/permissions](crates/core/permissions) | Core: Permission Logic |     |
| `core/presence` | [crates/core/presence](crates/core/presence) | Core: User Presence |     |
| `core/result` | [crates/core/result](crates/core/result) | Core: Result and Error types |     |
| `delta` | [crates/delta](crates/delta) | REST API server |  |
| `bonfire` | [crates/bonfire](crates/bonfire) | WebSocket events server |  |
| `services/january` | [crates/services/january](crates/services/january) | Proxy server |  |
| `services/autumn` | [crates/services/autumn](crates/services/autumn) | File server |  |
| `bindings/node` | [crates/bindings/node](crates/bindings/node) | Node.js bindings for the Revolt software |  |
## Minimum Supported Rust Version
Rust 1.76 or higher.
> [!CAUTION]
> The events server has a significant performance regression between Rust 1.77.2 and 1.78.0 onwards, see [issue #341](https://github.com/revoltchat/backend/issues/341).
## Development Guide
Before contributing, make yourself familiar with [our contribution guidelines](https://developers.revolt.chat/contrib.html) and the [technical documentation for this project](https://revoltchat.github.io/backend/).
Before getting started, you'll want to install:
- Rust toolchain (rustup recommended)
- Docker
- Git
- mold (optional, faster compilation)
> A **default.nix** is available for Nix users!
> Just run `nix-shell` and continue.
As a heads-up, the development environment uses the following ports:
| Service | Port |
| ------------------------- | :------------: |
| MongoDB | 14017 |
| Redis | 14079 |
| MinIO | 14009 |
| Maildev | 14025
14080 |
| Revolt Web App | 14701 |
| `crates/delta` | 14702 |
| `crates/bonfire` | 14703 |
| `crates/services/autumn` | 14704 |
| `crates/services/january` | 14705 |
Now you can clone and build the project:
```bash
git clone https://github.com/revoltchat/backend revolt-backend
cd revolt-backend
cargo build
```
A default configuration `Revolt.toml` is present in this project that is suited for development.
If you'd like to change anything, create a `Revolt.overrides.toml` file and specify relevant variables.
> [!TIP]
> Use Sentry to catch unexpected service errors:
>
> ```toml
> # Revolt.overrides.toml
> [sentry]
> api = "https://[email protected]/1"
> events = "https://[email protected]/1"
> files = "https://[email protected]/1"
> proxy = "https://[email protected]/1"
> ```
Then continue:
```bash
# start other necessary services
docker compose up -d
# run the API server
cargo run --bin revolt-delta
# run the events server
cargo run --bin revolt-bonfire
# run the file server
cargo run --bin revolt-autumn
# run th proxy server
cargo run --bin revolt-january
# hint:
# mold -run
```
You can start a web client by doing the following:
```bash
# if you do not have yarn yet and have a modern Node.js:
corepack enable
# clone the web client and run it:
git clone --recursive https://github.com/revoltchat/revite
cd revite
yarn
yarn build:deps
echo "VITE_API_URL=http://local.revolt.chat:14702" > .env.local
yarn dev --port 14701
```
Then go to http://local.revolt.chat:14701 to create an account/login.
When signing up, go to http://localhost:14080 to find confirmation/password reset emails.
## Deployment Guide
### Cutting new crate releases
Begin by bumping crate versions:
```bash
just patch # 0.0.X
just minor # 0.X.0
just major # X.0.0
```
Then commit the changes to package files.
Proceed to publish all the new crates:
```bash
just publish
```
### Cutting new binary releases
Tag and push a new release by running:
```bash
just release
```
If you have bumped the crate versions, proceed to [GitHub releases](https://github.com/revoltchat/backend/releases/new) to create a changelog.
## Testing
First, start the required services:
```sh
docker compose -f docker-compose.db.yml up -d
```
Now run tests for whichever database:
```sh
TEST_DB=REFERENCE cargo nextest run
TEST_DB=MONGODB cargo nextest run
```
## License
The Revolt backend is generally licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/backend/blob/master/LICENSE).
**Individual crates may supply their own licenses!**