Stream content from your PC to the internet
This application is a Node.js application using Express.js.
- Node.js web server using Express.js
- User Interface using HTML, CSS and Javascript.
- Bootstrap
- Icons with fontawesome
- Bundling frontend JS with Browserify
- Project specific environment variables using
.env
file, see.env.example
to see the required variables.
config values we needed to run the application can be gotten from your twilio account dashboard.
Config Value | Description |
---|---|
Account Sid | Your primary Twilio account identifier - find this in the Console. |
Api Key Sid | Used to authenticate - find this here. |
Api Key Secret | Used to authenticate - find this here |
After the above requirements have been met:
- Clone this repository and
cd
into it
git clone https://github.com/Godwin9911/stream-my-pc.git
cd stream-my-pc
- Install dependencies
npm install
- create .env and Set your environment variables using .env.example as a guide
ACCOUNT_SID = YOUR_TWILIO_ACCOUNT_SID
API_KEY_SID = YOUR_API_KEY_SID
API_KEY_SECRET = YOUR_API_KEY_SECRET
See Twilio Account Settings on how locate the necessary environment variables.
- Bundle frontend JS
npm run build
- Run the application
npm start
Alternatively, you can use this command to start the server in development mode. It will reload whenever you change any files.
npm run dev
- Navigate to https://localhost:5000
That's it!
No Tests
Additionally to trying out this application locally, you can deploy it to a variety of host services.
Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.
Service | Cloud |
---|---|
Heroku |
- Using the Screen Capture API - Web APIs
- Screen Capture - Twilio
- Getting Started - Twilio
- WebRTC samples
- Sketch Pad
This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.
No warranty expressed or implied. Software is as is.