Mirrors/webring
2
0
Fork 0
mirror of https://github.com/maxboeck/webring synced 2024-11-13 23:37:09 +00:00
Code Issues Projects Releases Packages Wiki Activity
webring/README.md
Max Böck 33b987e69c add local development section to README
2019-04-15 08:40:56 +02:00

1.5 KiB
Raw Blame History

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