Git Product home page Git Product logo

briefing's Introduction

Brie.fi/ng

Choose your language: en | de

Privacy is the central idea behind this project. Only open technologies (such as WebRTC) are used, which work with all modern browsers. Thus, no installation of additional software is required, and the approach remains future-proof.

A conversation can be started immediately for free via Brie.fi/ng. A free iOS app is also available.

Features such as desktop sharing, text chat and simple invitation links are available. More can be easily added with knowledge of Javascript and Vue.

Quick start for developers

Download or clone the project to your local machine, and you are ready to go:

npm install
npm run start

Batteries included

A WebRTC video chat application requires multiple components to work properly. Briefing includes everything you need to get started: User Interface, Signaling and STUN.

Learn more about it in the โ†’ documentation.

connection

Customization / Whitelabeling

To use Briefing for your own project, the following options for all levels of experience are available:

  1. create a room via Brie.fi/ng and copy the link into your website.
  2. embed Briefing via 'frame' into your own site. Use the handy configurator.
  3. start Briefing on your own server e.g. via Docker or use a service like fly.io, render.com, Google Cloud, AWS, Azure ... you name it.
  4. customize the source code according to your needs. See the documentation for details.

Learn more at โ†’ installation.

Licenses

In general Briefing is free, however a commercial license is also available, which I ask you to purchase, especially for "white labeling" applications. Otherwise, I appreciate support for the project through sponsorship via GitHub to support further development. Thanks.

Public License

The terms of the EUPL (European Union Public License 1.2) must be followed, which are similar to those of the AGPL. Modifications must also be free and made available to the public under the same license. For a quick overview of the license, see https://choosealicense.com/licenses/eupl-1.2/. This license is also available in the European Community languages.

Commercial license

For commercial use or closed source projects / "white labeling" I offer a license with the following conditions:

Worldwide, non-exclusive, non-transferable, non-sublicensable license of Briefing, as found at https:// github.com/holtwick/briefing/, for use in purchaser's products, as long as the resulting software is not in competition with Briefing itself. Any liability is excluded. The law of the Federal Republic of Germany applies exclusively.

The one-time fee is 499 EUR net. Please contact [email protected] or buy directly via Paddle.

Author

My name is Dirk Holtwick. I am an independent software developer based in Germany. Learn more about my work at holtwick.de.

Contribute

Contributions are always welcome. The best place to start is to add or respond to Issues.

To add or correct translations, start here: โ†’ locales.

Major Releases

Version 3.0

Full migration to Vue3 and Typescript. Localization using vue-i18n standard library. Modernization of many parts of the project. See โ†’ blog post (de)

Version 2.0

Introduced Typescript support. Migration to Vite. Replacing socket.io with reliable Zerva. Docker images. Reduction to the essential parts of the project. See โ†’ blog post (de)

Version 1.0

Based on Webpack and had examples for iOS, Android, Windows, and Electron, as well as a separate signal server. It also offered background blur and image backgrounds via Unsplash. All of these implementations were deprecated. However, the code is still accessible via the legacy branch, but is no longer maintained or supported.


This document is also available in German language.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.