Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miroslavpejic85/call-me
🟢 Call-Me: Your Go-To for Instant Video Calls!
https://github.com/miroslavpejic85/call-me
call communication decentralized docker peer webrtc
Last synced: 7 days ago
JSON representation
🟢 Call-Me: Your Go-To for Instant Video Calls!
- Host: GitHub
- URL: https://github.com/miroslavpejic85/call-me
- Owner: miroslavpejic85
- License: agpl-3.0
- Created: 2024-09-12T18:03:13.000Z (21 days ago)
- Default Branch: main
- Last Pushed: 2024-09-15T14:14:37.000Z (18 days ago)
- Last Synced: 2024-09-16T08:56:37.259Z (17 days ago)
- Topics: call, communication, decentralized, docker, peer, webrtc
- Language: JavaScript
- Homepage: https://cme.mirotalk.com
- Size: 2.15 MB
- Stars: 60
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Call-Me
This project enables easy one-to-one video calls directly from your web browser using WebRTC technology.
## Getting Started
### Overview
This project allows you to:
- `Sign in` with a username.
- `Make video calls` by entering the recipient's username.
- `Toggle` your video feed visibility.
- `Hang up` the call when done.
- `Rest API` to get all connected users.
---
### Quick Start
**[Install Node.js and npm](https://nodejs.org/en/download)**
```shell
# Copy .env.template to .env
cp .env.template .env
# Install dependencies
npm install
# Start the application
npm start
```
1. Open your browser and visit [http://localhost:8000](http://localhost:8000).
2. Sign in with your username.
3. Enter the recipient's username and click `Call`.
4. Enjoy your one-to-one video call.
---
## One-Click Call Between Two Users
Allows a user to `join` the room as a `user1`
[http://localhost:8000/join?user=user1](http://localhost:8000/join?user=user1)
Lets the `user2 join` the room and initiate a `call` to the `user1`
[http://localhost:8000/join?user=user2&call=user1](http://localhost:8000/join?user=user2&call=user1)
---
## API
Get all connected users
```shell
curl -X GET "http://localhost:8000/api/v1/users" -H "authorization: call_me_api_key_secret" -H "Content-Type: application/json"
```
Docs: http://localhost:8000/api/v1/docs/ or you can check it out live [here](https://cme.mirotalk.com/api/v1/docs/).
---
## Self-Hosting
To install this on your VPS, VDS, or personal server, please follow the instructions in **[the self-hosting documentation](./doc/self-hosting.md)**.
---