marker/shuffle-cracked
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: making local installation docs more specific

Browse Source
This commit is contained in:
Aditya
2023-11-03 23:17:13 +05:30
parent 9197705660
commit bf34085898
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/install-guide.md
+8 -3
View File
@@ -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** **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 ## 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. 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) 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 => 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! 4. Make the changes you want, then restart the backend server!
5. With your changes made, make a pull request :fire: 5. With your changes made, make a pull request :fire:
## Database - Opensearch ## 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 ## Orborus
Execution of Workflows: Execution of Workflows: