[mirotalk] - update readme

This commit is contained in:
Miroslav Pejic
2021-01-03 18:14:02 +01:00
parent 974d742950
commit 95f65f801e
+11 -3
View File
@@ -42,9 +42,10 @@ cd mirotalk
## Set up credentials
- Copy .env.template to .env `cp .env.template .env`
`Turn`
- Copy .env.template to .env `cp .env.template .env`
- Create an account on http://numb.viagenie.ca
- Get your Account USERNAME and PASSWORD
- Fill in your credentials in the `.env` file
@@ -53,7 +54,7 @@ cd mirotalk
- Get started for free https://ngrok.com/
- Fill in your authtoken in the `.env` file
- Enable it, if you want to expose the server using the https tunel
- Set `NGROK_ENABLED=true`, if you want to expose the server using the https tunel, starting it from your local pc.
## Install dependencies
@@ -71,11 +72,18 @@ npm start
- If you want to use a client on another computer/network, make sure you publish your server on an HTTPS connection.
You can use a service like [ngrok](https://ngrok.com/) Or deploy it on [heroku](https://www.heroku.com/).
## Demo
- Open https://mirotalk.herokuapp.com/
- Allow to use the camera and microphone
- Click the first button to copy the url and then share it
- Wait someone to join for video conference
## Contributing
Pull Requests are welcome! :slightly_smiling_face:
Please run [prettier](https://prettier.io) on all of your PRs before submitting, this can be done with `prettier --write mirotalk/` in the project directory.
Please run [prettier](https://prettier.io) on all of your PRs before submitting, this can be done with `prettier --write mirotalk/`.
For communication we use Gitter Chat which can be found here: