Added changes to install guide
This commit is contained in:
+17
-7
@@ -82,8 +82,13 @@ docker-compose up
|
||||
|
||||
Related issue: #47
|
||||
|
||||
## Local development installation
|
||||
**Frontend - ReactJS /w cytoscape**
|
||||
# Local development installation
|
||||
Local development is pretty straight forward with **ReactJS** and **Golang**. This part is intended to help you run the code for development purposes.
|
||||
|
||||
**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**
|
||||
|
||||
## 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.
|
||||
```bash
|
||||
cd frontend
|
||||
@@ -91,29 +96,32 @@ npm i
|
||||
npm start
|
||||
```
|
||||
|
||||
**Backend - Golang**
|
||||
## Backend - Golang
|
||||
http://localhost:5001 - REST API - requires [>=go1.13](https://golang.org/dl/)
|
||||
```bash
|
||||
export DATASTORE_EMULATOR_HOST=0.0.0.0:8000
|
||||
cd backend/go-app
|
||||
go build
|
||||
go run *.go
|
||||
```
|
||||
|
||||
**Database - Datastore**
|
||||
**WINDOWS USERS:** You'll have to to add the "export" part as an environment variable.
|
||||
|
||||
## Database - Datastore
|
||||
Based on Google datastore
|
||||
```
|
||||
docker run -p 8000:8000 google/cloud-sdk gcloud beta emulators datastore start --project=shuffle --host-port 0.0.0.0:8000 --no-store-on-disk
|
||||
```
|
||||
|
||||
**Orborus**
|
||||
## Orborus
|
||||
Execution of Workflows:
|
||||
PS: This requires some specific environment variables
|
||||
```
|
||||
cd functions/onprem/orborus
|
||||
go run orborus.go
|
||||
```
|
||||
Environments:
|
||||
|
||||
|
||||
Environments (modify for Windows):
|
||||
```
|
||||
export ORG_ID=Shuffle
|
||||
export ENVIRONMENT_NAME=Shuffle
|
||||
@@ -122,4 +130,6 @@ export DOCKER_API_VERSION=1.40
|
||||
export SHUFFLE_PASS_WORKER_PROXY=${SHUFFLE_PASS_WORKER_PROXY}
|
||||
```
|
||||
|
||||
**WINDOWS USERS:** You'll have to to add the "export" part as an environment variable.
|
||||
|
||||
AND THAT's it - hopefully it worked. If it didn't please email [frikky@shuffler.io](mailto:frikky@shuffler.io)
|
||||
|
||||
Reference in New Issue
Block a user