From 8ebb6cc22e0367f762323f209dcd48bfa3783dcd Mon Sep 17 00:00:00 2001 From: pabloFuente Date: Mon, 20 Jun 2022 19:21:08 +0200 Subject: [PATCH] Add README files to openvidu-basic-X applications --- openvidu-basic-java/README.md | 16 ++++++++++++++++ openvidu-basic-java/pom.xml | 4 +++- openvidu-basic-node/.env | 2 ++ openvidu-basic-node/.gitignore | 1 - openvidu-basic-node/README.md | 21 +++++++++++++++++++++ openvidu-basic-python/README.md | 12 +++++++++--- 6 files changed, 51 insertions(+), 5 deletions(-) create mode 100644 openvidu-basic-java/README.md create mode 100644 openvidu-basic-node/.env create mode 100644 openvidu-basic-node/README.md diff --git a/openvidu-basic-java/README.md b/openvidu-basic-java/README.md new file mode 100644 index 00000000..19ca76cc --- /dev/null +++ b/openvidu-basic-java/README.md @@ -0,0 +1,16 @@ +# openvidu-basic-java + +This is a minimal OpenVidu server application sample built for Java with Spring Boot. Visit [Application server](https://docs.openvidu.io/en/stable/application-server/) documentation for further context. + +It internally uses [openvidu-java-client SDK](https://docs.openvidu.io/en/stable/reference-docs/openvidu-java-client/). + +Prerequisites: + +- [Java (>=11)](https://www.java.com/en/download/manual.jsp) +- [Maven](https://maven.apache.org) + +To run the application: + +``` +mvn spring-boot:run +``` \ No newline at end of file diff --git a/openvidu-basic-java/pom.xml b/openvidu-basic-java/pom.xml index 8407db05..b5593fdd 100644 --- a/openvidu-basic-java/pom.xml +++ b/openvidu-basic-java/pom.xml @@ -19,7 +19,9 @@ UTF-8 - 1.8 + 11 + 11 + 11 io.openvidu.basic.java.App diff --git a/openvidu-basic-node/.env b/openvidu-basic-node/.env new file mode 100644 index 00000000..6a8752e1 --- /dev/null +++ b/openvidu-basic-node/.env @@ -0,0 +1,2 @@ +OPENVIDU_URL=https://localhost:4443/ +OPENVIDU_SECRET=MY_SECRET \ No newline at end of file diff --git a/openvidu-basic-node/.gitignore b/openvidu-basic-node/.gitignore index 6a7d6d8e..fa6a20f5 100644 --- a/openvidu-basic-node/.gitignore +++ b/openvidu-basic-node/.gitignore @@ -73,7 +73,6 @@ web_modules/ .yarn-integrity # dotenv environment variable files -.env .env.development.local .env.test.local .env.production.local diff --git a/openvidu-basic-node/README.md b/openvidu-basic-node/README.md new file mode 100644 index 00000000..1cda0d35 --- /dev/null +++ b/openvidu-basic-node/README.md @@ -0,0 +1,21 @@ +# openvidu-basic-node + +This is a minimal OpenVidu server application sample built for Node with Express. Visit [Application server](https://docs.openvidu.io/en/stable/application-server/) documentation for further context. + +It internally uses [openvidu-node-client SDK](https://docs.openvidu.io/en/stable/reference-docs/openvidu-node-client/). + +Prerequisites: + +- [Node](https://nodejs.org/es/download/) + +Install dependencies: + +``` +npm install +``` + +Run the application: + +``` +node index.js +``` \ No newline at end of file diff --git a/openvidu-basic-python/README.md b/openvidu-basic-python/README.md index 8e7e2da2..66b34465 100644 --- a/openvidu-basic-python/README.md +++ b/openvidu-basic-python/README.md @@ -1,6 +1,12 @@ # openvidu-basic-python -Create a python3 environment and activate it +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: + +- [Python 3](https://www.python.org/downloads/) + +Create a python3 environment and activate it: ``` python3 -m venv venv @@ -10,13 +16,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