Symfonia

About

This is a WIP implementation of a Spacebar compatible Server in Rust!

This repository contains: A partial implementation of:

• HTTP API Server
• HTTP CDN Server
• WebSocket Gateway Server
• Database Models

Local Development Environment

Whether you are using Docker or not, you will need to have the following installed:

• Rust
• git
• sqlx-cli

If your development environment is hosted on a Windows machine, please additionally make sure that you have a bash shell available to execute pre-commit hooks. This can be done by installing Git Bash or Windows Subsystem for Linux 2 and, additionally, configuring your IDE correctly.

See the instructions below for guidance on how to run the project.

Non-Docker

1. Install and host a PostgreSQL database
2. Create a new database, and a user that has full access to that database
3. Create a .env file in the root of the project with the following contents:

DATABASE_HOST=[ip/domain of your Postgres database]
DATABASE_PORT=[Postgres port, usually 5432]
DATABASE_USERNAME=[Your Postgres username]
DATABASE_PASSWORD=[Your Postgres password]
DATABASE_NAME=[Your Postgres database name]
API_BIND=[ip:port to bind the HTTP API server to. Defaults to 0.0.0.0:3001 if not set]
GATEWAY_BIND=[ip:port to bind the Gateway server to. Defaults to 0.0.0.0:3003 if not set]

4. Install the sqlx CLI with cargo install sqlx-cli
5. Run cargo sqlx migrate run from within the project directory to run the migrations
6. Run the project with cargo run.

Docker

1. Copy the compose-example.env file to .env in the root of the project and fill in the values to your liking.
2. Adjust ports in docker-compose.yml if needed.
3. Run docker compose up --build.

Code changes will require you to restart the container with docker compose up --build. If you want to reset to a fully clean state, run docker compose down -v.