Skip to content

README.md

Latest commit

 

History

History
62 lines (52 loc) · 1.51 KB

README.md

File metadata and controls

62 lines (52 loc) · 1.51 KB
Raw

gummyRing

gummyRing is a tool for simple, pretty, js-free, webrings

Features

  • Custom webring name
  • Easy set up
  • Completely server side
  • Super cool

Setup

Requirements

  • recent nodejs version
  • recent npm version
  • common sense

Installation

git clone https://github.com/sebastian-92/gummyRing.git
cd gummyRing
npm i

Configuration

You can configure pretty much everything in config.json.

{
    "links" : [
        "https://cbass92.org"
    ],
    "ringName" : "gummyring template",
    "joinURL" : "join.html"
}

links - links go here
ringName - the name of your webring
joinURL - optional, a link shown for users wanting to join your webring

Other vital config info

  • In the ./public directory, there is join.html. you should probably change that or point joinURL in the config to something else
  • The links thingy only works with full urls, with the protocol.

Startup

node server.js

Usage

After setup, the service should be running on port 3000.
All webring members need to do is add the following html to their website:

<iframe src="YOURSITEHERE/ring?id=INDEX"></iframe>

INDEX should be the index of where their website is in the sitelist, starting with 0.

Contributing

Contributions are welcome! Please open issues and submit pull requests!

Credits

License

This project is licensed under the MIT License, because open source & free software are so peak.