... | ... | @@ -5,7 +5,7 @@ The backend part of Stork is written in Go language while the UI is written in A |
|
|
|
|
|
## Folders
|
|
|
|
|
|
- api - API exposed to users by Stork Server defined using Swagger
|
|
|
- api - API exposed to users by Stork Server defined using Swagger
|
|
|
- backend - the backend part of Stork, written in GoLang
|
|
|
- backend/api - API exposed by Stork Agents to Stork Server, defined gRPC and protobuf
|
|
|
- backend/agent - source code of STAG (Stork Agent)
|
... | ... | @@ -20,10 +20,10 @@ The backend part of Stork is written in Go language while the UI is written in A |
|
|
|
|
|
## Files
|
|
|
- docker-compose.yaml - docker-compose file that arranges all services together and allows running whole solution under the desk
|
|
|
- Rakefile - a file with variuos tasks like getting dependencies or building backend and frontend or running docker compose
|
|
|
- Rakefile - a file with various tasks like getting dependencies or building backend and frontend or running docker compose
|
|
|
- README.md
|
|
|
- api/swagger.yaml - REST API definition shared by WebUI and Stork Server
|
|
|
- Vagrantfile - a config for Vagrant that allows bringing up Ubunut 18.04 VM with preinstalled dependencies, ready for doing development
|
|
|
- Vagrantfile - a config for Vagrant that allows bringing up Ubuntu 18.04 VM with preinstalled dependencies, ready for doing development
|
|
|
|
|
|
# Dependencies
|
|
|
|
... | ... | @@ -46,7 +46,7 @@ All these dependencies are downloaded by `rake prepare_env`. |
|
|
## Frontend Dependencies
|
|
|
All these dependencies are downloaded by `rake prepare_env`.
|
|
|
|
|
|
- swagger_codegen.jar - official Swagger code generator in Java used for generating frontend part of REST API
|
|
|
- swagger_codegen.jar - official Swagger code generator in Java used for generating frontend part of REST API
|
|
|
- nodejs & npm - used for getting javascript dependencies for frontend and building it
|
|
|
|
|
|
# Rakefile
|
... | ... | @@ -104,12 +104,12 @@ Static analysis: |
|
|
$ rake lint_go
|
|
|
```
|
|
|
|
|
|
Runnig agent:
|
|
|
Running agent:
|
|
|
```console
|
|
|
$ rake run_agent
|
|
|
```
|
|
|
|
|
|
Runnig server:
|
|
|
Running server:
|
|
|
```console
|
|
|
$ rake run_server
|
|
|
```
|
... | ... | @@ -138,4 +138,4 @@ Building and running demo: |
|
|
$ rake docker_up
|
|
|
```
|
|
|
|
|
|
and now visit in a web browser: http://localhost:8080/ |
|
|
\ No newline at end of file |
|
|
and now visit in a web browser: http://localhost:8080/ |