From b4ed8f3c7c29b4179c79bbe843a58e9826a0e4c6 Mon Sep 17 00:00:00 2001 From: pabloFuente Date: Mon, 11 Jul 2022 14:20:58 +0200 Subject: [PATCH] Unify server application READMEs --- openvidu-basic-dotnet/README.md | 11 +++++++++-- openvidu-basic-java/README.md | 11 +++++++++-- openvidu-basic-node/README.md | 18 ++++++++++++------ openvidu-basic-python/README.md | 12 +++++++----- 4 files changed, 37 insertions(+), 15 deletions(-) diff --git a/openvidu-basic-dotnet/README.md b/openvidu-basic-dotnet/README.md index c0183857..79c5167b 100644 --- a/openvidu-basic-dotnet/README.md +++ b/openvidu-basic-dotnet/README.md @@ -2,14 +2,21 @@ This is a minimal OpenVidu server application sample built for .NET. Visit [Application server](https://docs.openvidu.io/en/stable/application-server/) documentation for further context. -Prerequisites: +## Prerequisites - [.NET 6.0](https://dotnet.microsoft.com/en-us/download) -Run the application: +## Run + +Download repository ``` git clone git@github.com:OpenVidu/openvidu-tutorials.git cd openvidu-tutorials/openvidu-basic-dotnet +``` + +Run the application + +``` dotnet run ``` \ No newline at end of file diff --git a/openvidu-basic-java/README.md b/openvidu-basic-java/README.md index 3e317d7f..073cee1e 100644 --- a/openvidu-basic-java/README.md +++ b/openvidu-basic-java/README.md @@ -4,15 +4,22 @@ This is a minimal OpenVidu server application sample built for Java with Spring It internally uses [openvidu-java-client SDK](https://docs.openvidu.io/en/stable/reference-docs/openvidu-java-client/). -Prerequisites: +## Prerequisites - [Java (>=11)](https://www.java.com/en/download/manual.jsp) - [Maven](https://maven.apache.org) -To run the application: +## Run + +Download repository ``` git clone git@github.com:OpenVidu/openvidu-tutorials.git cd openvidu-tutorials/openvidu-basic-java +``` + +Run the application + +``` mvn spring-boot:run ``` \ No newline at end of file diff --git a/openvidu-basic-node/README.md b/openvidu-basic-node/README.md index 1ba4e8f1..1e2d3c71 100644 --- a/openvidu-basic-node/README.md +++ b/openvidu-basic-node/README.md @@ -4,21 +4,27 @@ This is a minimal OpenVidu server application sample built for Node with Express It internally uses [openvidu-node-client SDK](https://docs.openvidu.io/en/stable/reference-docs/openvidu-node-client/). -Prerequisites: +## Prerequisites - [Node](https://nodejs.org/es/download/) -Install dependencies: +## Run + +Download repository + +``` +git clone git@github.com:OpenVidu/openvidu-tutorials.git +cd openvidu-tutorials/openvidu-basic-node +``` + +Install dependencies ``` npm install ``` -Run the application: +Run the application ``` -git clone git@github.com:OpenVidu/openvidu-tutorials.git -cd openvidu-tutorials/openvidu-basic-node -npm i node index.js ``` \ No newline at end of file diff --git a/openvidu-basic-python/README.md b/openvidu-basic-python/README.md index d094fe68..db0bdaf0 100644 --- a/openvidu-basic-python/README.md +++ b/openvidu-basic-python/README.md @@ -2,18 +2,20 @@ This is a minimal OpenVidu server application sample built for Python with [Flask](https://flask.palletsprojects.com/). Visit [Application server](https://docs.openvidu.io/en/stable/application-server/) documentation for further context. -Prerequisites: +## Prerequisites - [Python 3](https://www.python.org/downloads/) -Download repository: +## Run + +Download repository ``` git clone git@github.com:OpenVidu/openvidu-tutorials.git cd openvidu-tutorials/openvidu-basic-python ``` -Create a python3 environment and activate it: +Create a python3 environment and activate it ``` python3 -m venv venv @@ -23,13 +25,13 @@ python3 -m venv venv . venv/bin/activate ``` -Install dependencies: +Install dependencies ``` pip install -r requirements.txt ``` -Run the application: +Run the application ``` python3 app.py