broadcast-channel Documentation

Satellite: BroadcastChannel to send data between different browser-tabs or nodejs-processes :satellite: + LeaderElection over the channels

1,993 stars JavaScript JavaScript 1 file ยท ~969 tokens #broadcast#broadcast-channel#broker#channels#client-side
RAW Doc

1. Project Overview & Quickstart (pubkey/broadcast-channel)

BroadcastChannel


A BroadcastChannel that allows you to send data between different browser-tabs or nodejs-processes.
And a LeaderElection over the channels.

[Read the full documentation on github](https://github.com/pubkey/broadcast-channel)

2. Official Technical Reference & Guides (pubkey/website)

text
<a href="https://github.com/json-schema-org/website/graphs/contributors" alt="JSON Schema GitHub website contributors">
  
</a>
<a href="https://github.com/json-schema-org/website/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22" alt="Good First JSON Schema issue">
  
</a>
<a href="https://github.com/json-schema-org/.github/blob/main/CODE_OF_CONDUCT.md" alt="Contributor Covenant">
  
</a> 
<a href="https://www.repostatus.org/#active" alt="Repo status">
  
</a> 
<a href="https://json-schema.org/slack" alt="JSON Schema Slack">
  
</a>

๐Ÿ‘‹ Welcome to the JSON Schema website

This repository contains the source code of the JSON Schema website:

  • Powered by Next.js,
  • Uses the Tailwind CSS framework,
  • Built and deployed with Netlify.

Setting up the Project

Please refer to INSTALLATION.md for instructions on how to set up the project for local development.

Project structure

This repository has the following structure:

text
โ”œโ”€โ”€ .github                     # Definitions of GitHub workflows, pull request, and issue templates
  โ”œโ”€โ”€ components                  # Various generic components such as "Button", "Figure", etc.
  โ”œโ”€โ”€ data                        # JSON Schema implementations
  โ”œโ”€โ”€ styles                      # Various CSS files
  โ”œโ”€โ”€ lib                         # Various JS code for preparing static data to render on pages
  โ”œโ”€โ”€ pages                       # Website's pages source, including raw markdown files and React page templates
  โ”‚    โ”œโ”€โ”€ overview               # JSON Schema initiative docs
  โ”‚    โ”œโ”€โ”€ blog                   # Blog posts
  โ”‚    โ”œโ”€โ”€ learn                  # JSON Schema docs
  โ”‚    โ””โ”€โ”€ implementations        # Various pages to describe tools
  โ”œโ”€โ”€ public                      # Data for site metadata and static assets such as images
  โ”œโ”€โ”€ next.config.js              # Next.js configuration file

Contribute

Here are some areas where you can contribute to the website:

  • Blog posts
  • Case studies
  • Design
  • Documentation improvements
  • Website enhancements
  • Add a new JSON Schema implementation
  • JSON Schema Landscape

To identify good first issues to work on, join our Slack workspace and visit the #contribute channel. This channel is specifically designed for onboarding and supporting new contributors.

You should also check out our Contributing guidelines.

Contributors

Thanks to these wonderful people who contributed to this website:

Made with contributors-img.

Sponsors

Backers

Thank you to all our backers!

Connect with the JSON Schema Community




Inspired by

This document was inspired by AsyncAPI website README.md.

License

The contents of this repository are licensed under either the BSD 3-clause license or the Academic Free License v3.0. See LICENSE.