0.0.1 • Published 3 years ago

@open-webring/schema v0.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
3 years ago

open-webring

Join a webring, create your own, or fork this repository and host your own for free.

Rings are available at https://openwebring.com/ring/[slug].json. See the sample webring for an example.

Manifesto

Do you remember when the internet used to be fun? Back in the days before search engines indexed everything, before the internet was hyper-optimized for business, webrings were the de-facto way to discover content. Open-Webring is designed for hobbyists, enthusiasts, artists, nostalgists, and creatives that would like to share their work in inclusive, online communities.

Reproduced from here.

TODO: Talk about membership.

How To Join a Webring

  1. Add an entry to the ring you wish to join in public/ring and submit a PR to this repository. For example, we can join the sample webring which has the has the schema definition:

    {
      "name": "string",
      "title": "string",
      "url": "string"
    }

    so a valid entry could be:

    {
      "name": "Michael D'Angelo",
      "title": "Software Engineer",
      "url": "https://mldangelo.com"
    }
  2. Add open-webring to your website. Webrings can be added to your site in many formats. The simplest way is to add:

      <script async type="text/javascript" src="https://openwebring.com/ring/sample.js" charset="utf-8"></script>

    to your website.

    Alternatively, you can add an iframe:

      <iframe src="demo_iframe.htm" height="200" width="300" title="Iframe Example"></iframe>

    Or fetch and parse the webring yourself using javascript

      fetch('https://openwebring.com/ring/sample.json')
        .then(response => response.json())
        .then(data => console.log(data));
  3. After we've validated that you have added open-webring to your site, we'll merge your PR and welcome you into the community.

Goals

  • Free, serverless webrings for anyone that wants to join.
  • JAM Stack. Use github as a JSON api - Heavily leverage GH ecosystem.
  • track changes to rings via git diff.
  • Enforce participation / auto moderation.

Developing

Developed with: node >= v14. nvm is recommended for managing node versions.

This repository is split into multiple parts:

  1. src which contains a Next.js app hosted at openwebring.com.
  2. public/ring which contains webring schemas and data.

Inspired By

  1. webring.org Circa 1999.
  2. ianww.com (probably would not have worked on this if I hadn't asked to join his webring)
  3. https://github.com/topics/webring - only 8 entries - none are communities
  4. https://github.com/XXIIVV/webring https://github.com/ckipp01/webring-cli - most active webring on github?
  5. https://github.com/maxboeck/webring - closest to this project
  6. https://github.com/hackclub/webring
  7. https://github.com/susam/10kbclub