2019-04-13 12:25:00 +00:00
# Webring Starter Kit
2019-04-14 19:36:15 +00:00
A boilerplate to host your own community of sites, also known as a [webring ](https://en.wikipedia.org/wiki/Webring ).
Inspired by this post from [Charlie Owen ](https://www.sonniesedge.net/posts/webrings ).
2019-04-13 12:25:00 +00:00
2019-04-14 19:36:15 +00:00
Uses [Eleventy ](https://www.11ty.io ) and [Netlify ](https://www.netlify.com/ ) to build a central directory for member sites. People can link to `/prev` , `/random` and `/next` and be redirected to members of the ring.
2019-04-13 12:25:00 +00:00
2019-04-14 19:46:59 +00:00
See the [Demo Site ](https://webringdemo.netlify.com )
2019-04-14 19:36:15 +00:00
* Admins manage the ring on Github
* Let people add their site through pull request or submit via Netlify Form
* Publish a Code of Conduct
* Provide an embed code that renders a badge (as a web component)
* Publish an index of all member RSS feeds
2019-04-13 12:25:00 +00:00
2019-04-14 19:06:19 +00:00
## How to host a ring
2019-04-13 12:25:00 +00:00
2019-04-14 19:06:19 +00:00
1. Fork this repo
2. Edit `src/data/meta.json` and fill in your community info
3. Remove the demo members in `src/data/members.json`
2019-04-14 19:46:59 +00:00
4. Deploy your site to Netlify
2019-04-14 19:06:19 +00:00
5. After you've set a domain, enter that in `meta.json` as well.
2019-04-13 16:45:22 +00:00
2019-04-14 19:06:19 +00:00
[![Deploy to Netlify ](https://www.netlify.com/img/deploy/button.svg )](https://app.netlify.com/start/deploy?repository=https://github.com/maxboeck/webring)