GraphQL backend for a multimedia dictionary
Go to file
Lucien Cartier-Tilet 50d55ed480
Add license and README
2023-01-03 16:20:31 +01:00
migrations Make Rust models for database schema 2023-01-03 16:11:43 +01:00
src Make Rust models for database schema 2023-01-03 16:11:43 +01:00
.env.example Initial commit with basic DB layout 2023-01-03 15:16:10 +01:00
.gitignore Initial commit with basic DB layout 2023-01-03 15:16:10 +01:00
Cargo.toml Make Rust models for database schema 2023-01-03 16:11:43 +01:00
LICENSE Add license and README 2023-01-03 16:20:31 +01:00
README.org Add license and README 2023-01-03 16:20:31 +01:00
diesel.toml Make Rust models for database schema 2023-01-03 16:11:43 +01:00
docker-compose.yml Initial commit with basic DB layout 2023-01-03 15:16:10 +01:00

README.org

Ordabok

Introduction

Ordabok is a backend for multimedia dictionaries powered by its users.

Compiling and running the project

This project requires an accessible PostgreSQL database (to store pretty much all of the projects data), an Appwrite instance (for managing user accounts), and an S3 bucket (to store images, videos, and audio). Copy .env.example with

$ cp .env.example .env

and modify the .env file accordingly. You will also need to set the variables for Appwrite and your S3 bucket.

Once this is done, execute the following command to run the backend.

$ cargo run
# or
$ cargo run --release

License

This project is under the AGPL 3.0 license. You can read the complete text here, and if you just want a quick understanding of it, you can go here.