ordabok/README.org

36 lines
1.3 KiB
Org Mode
Raw Normal View History

2023-01-03 15:20:31 +00:00
#+title: 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 project's data), an Appwrite instance (for
2023-01-03 15:20:31 +00:00
managing user accounts), and an S3 bucket (to store images, videos,
and audio). Copy ~.env.example~ with
#+begin_src shell
$ cp .env.example .env
#+end_src
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.
#+begin_src shell
$ cargo run
# or
$ cargo run --release
#+end_src
2023-01-17 00:29:13 +00:00
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 [[https://github.com/graphql-rust/juniper/issues/1098][this issue]].
- ~POST http://localhost:8000/graphql~ :: ~POST~ queries for the GraphQL
API.
2023-01-03 15:20:31 +00:00
* License
This project is under the AGPL 3.0 license. You can read the complete
text [[file:LICENSE][here]], and if you just want a quick understanding of it, you can
go [[https://tldrlegal.com/license/gnu-affero-general-public-license-v3-(agpl-3.0)][here]].