Skip to content

Commit bd72b36

Browse files
committed
Updated readme slightly
1 parent 9a57bda commit bd72b36

2 files changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Web application for [SOMEF](https://github.com/KnowledgeCaptureAndDiscovery/some
55
SOMEF Vider is a web application based on Vue.js and Flask to visualize the metadata retrieved from the
66
SOMEF API.
77

8+
## Demo
9+
We have a running demo in [https://somef.linkeddata.es](https://somef.linkeddata.es). If the demo is down, please let us know by opening an issue.
810

911
## Development Installation
1012
In the development installation client and service are independent. They are mounted and executed separately
@@ -75,5 +77,12 @@ $ mv dist ../server/static
7577
This last 2 mandates are (for now) the only difference between development and production. To run the tool
7678
follow the steps listed above at the "Service" section.
7779

80+
To generate the bundle with Docker, see the [client deployment instructions](https://github.com/SoftwareUnderstanding/SOMEF-Vider/blob/master/client/README.md).
81+
7882
## Authors
79-
@Vitoriox
83+
- @Vitoriox: design and implementation
84+
- @dgarijo: supervision, testing and deployment
85+
86+
## Contributing
87+
88+
If you find problems or if you wish to add new features, please let us know by opening an [issue](https://github.com/SoftwareUnderstanding/SOMEF-Vider/issues) or submitting a pull request.

client/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@ The dockerfile will build the client bundle application without the need of inst
55

66
To obtain and deploy the client bundle in the server, follow the instructions below:
77

8-
1- Build the image: `docker build -t vider-client .` This creates an image with the bundle inside it
8+
0. If the image already exists, delete it: `docker rmi -f <image_id_>`
99

10-
2- Copy the bundle outside:
10+
1. Build the image: `docker build -t vider-client .` This creates an image with the bundle inside it
11+
12+
2. Copy the bundle in your target folder:
1113
```
1214
docker run -it -v $PWD:/out vider-client /bin/bash
1315
#: mv dist /out
1416
```
1517
This will copy the bundle to the client folder.
1618

17-
3- Move the client bundle to the server: `mv dist ../server/static`
19+
3. Move the client bundle to the server: `mv dist ../server/static`
1820

19-
4- Run the server: `python -m flask run`
21+
4. Run the server: `python -m flask run`
2022

0 commit comments

Comments
 (0)