From 91065a616893dbc1c19447057fce3c0b4b59fc21 Mon Sep 17 00:00:00 2001 From: Emma Date: Sun, 26 Sep 2021 18:41:10 -0400 Subject: [PATCH] [no ci] Remove contributing file and instead direct people to docs (#248) This fixes a long standing issue where people would point to the frontend homepage where it says 'fully documented' then point to the README here and say 'well that's sure hypocritical' Thus the branch name :tiny_pumpkin: Co-authored-by: Geometrically <18202329+Geometrically@users.noreply.github.com> --- CONTRIBUTING.md | 20 -------------------- README.md | 2 +- 2 files changed, 1 insertion(+), 21 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 741fad4bc..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,20 +0,0 @@ -## Contributing - -Contributions to labrinth are welcome! However, we do have a couple dependencies that you need to get up and running. - -We reccomend using [Docker](https://www.docker.com/) for setting up your dev enviroment. If you have Docker and docker-compose installed, you may run: -```sh -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: -```sh -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: -```sh -sqlx database create -sqlx migrate run -``` diff --git a/README.md b/README.md index 5a59652be..9054e6f15 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ ## Modrinth's laboratory for its backend service & API! -Documentation coming soon™. +For contributing information, please see the labrinth section of the [Modrinth contributing guide](https://docs.modrinth.com/docs/details/contributing/#labrinth-backend-and-api). For documentation on the API itself, see the [API Spec](https://docs.modrinth.com/api-spec/).