ordabok/README.org

Ordabok

• Introduction
• Compiling and running the project
• License

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 project's 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

This makes the API available at http://localhost:8000/, with only three paths:

http://localhost:8000/

GraphiQL interface

GET http://localhost:8000/graphql?query=:query

GET queries for the GraphQL API. However, it does not work due to this issue.

POST http://localhost:8000/graphql

POST queries for the GraphQL API.

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.