From bf340858982867feb9836fdf0091061fd38b8893 Mon Sep 17 00:00:00 2001 From: Aditya <60684641+0x0elliot@users.noreply.github.com> Date: Fri, 3 Nov 2023 23:17:13 +0530 Subject: [PATCH] fix: making local installation docs more specific --- .github/install-guide.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/install-guide.md b/.github/install-guide.md index 23f9b75a..204174a8 100755 --- a/.github/install-guide.md +++ b/.github/install-guide.md @@ -79,7 +79,7 @@ Local development is pretty straight forward with **ReactJS** and **Golang**. Th **PS: You have to stop the Backend Docker container to get this one working** -**PPS: Use the "Launch" branch when developing to get it set up easier** +**PPS: Use the "main" branch when developing to get it set up easier** ## Frontend - ReactJS /w cytoscape http://localhost:3000 - Requires [npm](https://nodejs.org/en/download/)/[yarn](https://yarnpkg.com/lang/en/docs/install/#debian-stable)/your preferred manager. Runs independently from backend. @@ -107,13 +107,18 @@ Large portions of the backend is written in another repository - [shuffle-shared 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 +//replace github.com/frikky/shuffle-shared => ../../shuffle-shared ``` 4. Make the changes you want, then restart the backend server! 5. With your changes made, make a pull request :fire: ## Database - Opensearch -Make sure this is running through the docker-compose, and that the backend points to it with SHUFFLE_OPENSEARCH_URL defined +Make sure this is running through the docker-compose, and that the backend points to it with SHUFFLE_OPENSEARCH_URL defined. + +So essentially, what that means is: +1. Make sure you have docker-compose installed +2. Make sure you have the docker-compose.yml file from this repository +3. Run `docker-compose up opensearch -d` ## Orborus Execution of Workflows: