Merge branch 'readme' into 'master'

Update readme

Closes projectmgmt#44

See merge request !8

README.md

-TO RUN
+# PROVEE
 
-We need a ENVOY proxy to translate the grpc web http2 requests
-
-docker run -d -v \<\<insert path to directory here\>\>envoy.yaml:/etc/envoy/envoy.yaml:ro -p 8080:8080 -p 9090:9090 envoyproxy/envoy:v1.15.0
-
-NOTE you have to use complete path (sometimes it complains when using relative paths, no idea why)
-
-Start the vue application with the vue dashboard (probably easiest to use in cmd: vue ui)
-
-Start the server.js: node backend/server.js
-
-For the microservices for developing run the index.js file in  backend\microservices and load balancing\app
-
-(might have to install the packages first)
-
-For the entire microservices deployment build the docker image in that directory with
-docker build -t nodeapp .
-
-To run the deployment run:
-docker-compose up
+## Development
 
+Run both [backend](backend/README.md) and [frontend](frontend/README.md).
 
+Generate gRPC service classes whenever [protos](protos/README.md) change.

backend/README.md

-# Backend
+# provee-backend
 
 ## Development
 
@@ -16,4 +16,4 @@ Services can be scaled with `--scale` argument, e.g. `--scale projector=4`.
 
 `Dockerfile` defines a production container.
 
-There is no `docker-compose.yml` using it yet, because production deployment is likely going to use Kubernetes instead.
\ No newline at end of file
+There is no `docker-compose.yml` using it yet, because production deployment is likely going to use Kubernetes instead.

frontend/README.md

-FOR THE ENVOY PROXY (needed to translate from http1 to http2 otherwise grpcweb doesn't understand it):
+# provee-frontend
 
-docker run -d -v <<insert path to directory here>>envoy.yaml:/etc/envoy/envoy.yaml:ro -p 8080:8080 -p 9090:9090 envoyproxy/envoy:v1.15.0
+## Dependencies
 
-NOTE you have to use complete path (sometimes it complains when using relative paths, no idea why)
+```
+npm install
+```
 
+## Development
 
-Command with my path
+```
+npm start
+```
 
-docker run -d -v C:\Users\simen\OneDrive\Documents\GitHub\dummy-vue-grpc\envoy.yaml:/etc/envoy/envoy.yaml:ro -p 8080:8080 -p 9090:9090 envoyproxy/envoy:v1.15.0
+## Test
+
+Cypress E2E tests
+
+```
+npm run test:e2e
+```

protos/README.md

-# protos
+# provee-protos
 
-Contains all Protos (gRCP) files that are used to communicate between services in Provee
+Contains all gRPC proto files that are used to communicate between services.
 
 ## Dependencies
 
@@ -8,4 +8,12 @@ Contains all Protos (gRCP) files that are used to communicate between services i
 brew install protoc
 brew install protoc-gen-grpc-node
 npm install -g grpc-tools
-```
\ No newline at end of file
+```
+
+## Development
+
+Generate gRPC service classes whenever protos change.
+
+```
+./build.sh
+```