Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (17 loc) · 879 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (17 loc) · 879 Bytes
Raw

Contributing

Contributions to The XIV Repository api server are welcome! However, we do have a couple dependencies that you need to get up and running.

We recomend using Docker for setting up your dev enviroment. If you have Docker and docker-compose installed, you may run:

docker-compose up

which will deploy a Meilisearch container on port 7700, a PostgreSQL container on port 5432 and a pgAdmin web UI on port 8070. When prompted to input a server password in pgAdmin, simply enter nothing into the password field.

You will have to set up the database now. To do so, install the sqlx cli:

cargo install --git https://github.com/launchbadge/sqlx sqlx-cli --no-default-features --features postgres

then, run the following commands to create the database and install schemas:

sqlx database create
sqlx migrate run