No description
Find a file
2019-04-15 14:13:21 +02:00
.github add pull request template 2019-04-13 20:28:47 +02:00
_lambda fix bug in random function 2019-04-14 22:06:32 +02:00
_tasks add webpack 2019-04-15 14:13:21 +02:00
src add webpack 2019-04-15 14:13:21 +02:00
.eleventy.js refactor page templates 2019-04-15 10:18:14 +02:00
.gitignore add webpack 2019-04-15 14:13:21 +02:00
gulpfile.js add webpack 2019-04-15 14:13:21 +02:00
LICENSE add mit lecense 2019-04-13 17:41:04 +02:00
netlify.toml add redirect rules 2019-04-13 17:32:07 +02:00
package.json add webpack 2019-04-15 14:13:21 +02:00
README.md add local development section to README 2019-04-15 08:40:56 +02:00
yarn.lock add webpack 2019-04-15 14:13:21 +02:00

Webring Starter Kit

A boilerplate to host your own community of sites, also known as a webring.
Inspired by this post from Charlie Owen.

Uses Eleventy and Netlify to build a central directory for member sites. People can link to /prev, /random and /next and be redirected to members of the ring.

See the Demo Site

  • Admins manage the ring on Github
  • Members are defined in src/data/members.json
  • 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

How to host a ring

  1. Fork this repo
  2. Edit src/data/meta.json and fill in your community info
  3. Add an avatar image for your ring to src/assets/images
  4. Remove the demo members in src/data/members.json
  5. Deploy your site to Netlify
  6. After you've set a domain, enter that in meta.json as well.

Deploy to Netlify

Local Development

To build the site locally, run these commands:

# clone this repository
git clone git@github.com:maxboeck/webring.git

# go to the working directory
cd webring

# install dependencies
yarn

# start a local build server and the gulp pipeline
yarn start