From 56220e02b9f2a14b4f40e21960794d0dddc98c11 Mon Sep 17 00:00:00 2001 From: frikky Date: Mon, 30 Aug 2021 14:06:57 +0200 Subject: [PATCH] Added shuffle-shared references to the install guide for devs --- .github/install-guide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/install-guide.md b/.github/install-guide.md index 2798f9c8..a9f6d4cb 100644 --- a/.github/install-guide.md +++ b/.github/install-guide.md @@ -112,6 +112,16 @@ cd backend/go-app go run *.go ``` +Large portions of the backend is written in another repository - [shuffle-shared](https://github.com/frikky/shuffle-shared). If you want to update any of this code and test in realtime, we recommend following these steps: +1. Clone shuffle-shared to a local repository +2. Open the Shuffle backend's go.mod file (./shuffle/backend/go.mod) (**NOT** in shuffle-shared) +3. Change the following line to point to your directory AFTER the => +``` +//replace github.com/frikky/shuffle-shared => ../../../../git/shuffle-shared +``` +4. Make the changes you want, then restart the backend server! +5. With your changes made, make a pull request :fire: + **WINDOWS USERS:** You'll have to to add the "export" part as an environment variable. ## Database - Opensearch