mirror of
https://github.com/maxboeck/webring
synced 2024-11-12 23:07:12 +00:00
No description
.github | ||
_lambda | ||
_tasks | ||
src | ||
.eleventy.js | ||
.gitignore | ||
gulpfile.js | ||
LICENSE | ||
netlify.toml | ||
package.json | ||
README.md | ||
yarn.lock |
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
- Fork this repo
- Edit
src/data/meta.json
and fill in your community info - Add an avatar image for your ring to
src/assets/images
- Remove the demo members in
src/data/members.json
- Deploy your site to Netlify
- After you've set a domain, enter that in
meta.json
as well.
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