Skip to content

Feature/react Reimplement with React #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# environment
.env

# Logs
logs
*.log
npm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# Dependency directories
node_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# Neutrino build directory
build
56 changes: 56 additions & 0 deletions .neutrinorc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
const webpack = require('webpack')
const path = require('path');
const standardjs = require('@neutrinojs/standardjs');
const react = require('@neutrinojs/react');

module.exports = {
options: {
root: __dirname
},
use: [
standardjs(),
react({
html: {
template: path.resolve(__dirname, 'src/index.ejs'),
},
style: {
test: /\.(sa|sc|c)ss$/,
modulesTest: /\.module\.(sa|sc|c)ss$/,
loaders: [
{ loader: require.resolve('sass-loader'), useId: 'sass' }
]
}
}),

// Enable eslint autofixer
// Note: leads to hot-reload loops on errors
(neutrino) => {
neutrino.config.module.rule('lint').use('eslint').tap(args => {
args.fix = true
return args
})
},

// Resolve modules within ./src without relative URL
(neutrino) => {
const modules = neutrino.config.resolve.modules
modules.add(path.resolve(__dirname, 'src'))
modules.add(path.resolve(__dirname, 'node_modules'))
},

// Set environment
(neutrino) => {
neutrino.config.plugin('dotenv')
.use(require.resolve('dotenv-webpack'));

const commitHash = require('child_process')
.execSync('git rev-parse --short HEAD')
.toString();
const version = require('./package.json').version
neutrino.config.plugin('define')
.use(webpack.DefinePlugin, [{
'process.env.VERSION': JSON.stringify(`v${version}-${commitHash}`)
}]);
}
],
};
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2021 C3VOC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# Killer Experimental Video Internet Noise, KEVIN
WebRTC conferencing tool for bringing video and audio from multiple devices/participants into your video mixer.

## Install/Build
Clone the repository

```
git clone https://github.com/voc/kevin.git
cd kevin
npm install && npm run build
```

## Deployment
- Build and serve the kevin static files via your webserver
- Setup https://github.com/muaz-khan/RTCMultiConnection-Server on the same URL as signalling backend (preferably via a Reverse-Proxy)
- witht the default setup you need to set ```"socketMessageEvent": "rC3-VOCcast-Message"``` in the RTCMultiConnection-Server config.json

## Usage
### URL parameters
- roomid - use a fixed roomid (for all modes)
- width - pass custom width to ```/view```
- record - record the stream (activated if set at all)

## Contributing
Build and install dependencies like above.

### Run hot-reloading dev server
```
npm run start
```

### Use a RTCMulti server at a different address
You can overwrite the default backend from a .env file like so:
```bash
BACKEND_URL=http://localhost:5001/
```

### Changing webpack options
List the current webpack config with:
```
npx neutrino --inspect
```
It can be modified via .neutrinorc.js
12 changes: 0 additions & 12 deletions assets/bootstrap/css/bootstrap.min.css

This file was deleted.

7 changes: 0 additions & 7 deletions assets/bootstrap/js/bootstrap.min.js

This file was deleted.

Loading