https://github.com/mrsteele/projector.io
https://github.com/mrsteele/projector.io
projector
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mrsteele/projector.io
- Owner: mrsteele
- Created: 2017-01-19T03:11:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-02T04:55:10.000Z (over 8 years ago)
- Last Synced: 2024-04-26T00:26:05.379Z (about 1 year ago)
- Topics: projector
- Language: HTML
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# projector.io
A simple way to use node and expressjs to project on the fly any text to a client.
### Installation
Simply use `npm i projector.io --save` to install your dependencies.
### Setup
Setup is done easily. We hook into express to project on specified routes.
```js
const app = require('express')()
const server = require('http').Server(app)
const nodeProjector = require('projector.io')
// defaults listed below
nodeProjector(server, app, {
rootPath: '/', // the root bath to show the projection screen
cmdPath: '/cmd' // the command path
// authUsername: null, (optional) The basic auth username to secure the cmd route
// authPassword: null (optional) The basic auth password to secure the cmd route
})
server.listen(3000, () => {
console.log(`node-projector on port: 3000`)
console.log(`To access the command module, go to localhost:3000/cmd`)
})
```
### License
MIT