Stevens-26 / webring

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Stevens Students Webring

Learn what a webring is here!

API is hosted at https://sitring.eric.si

All majors, years, and alumnis welcome!

Joining

Feel free to make a PR to add yourself to data.json if you are

  • A current student
  • An alumni
  • A professor
  • Anyone that had a duckcard

By joining, you agree you will implement the webring in the footer of your website.

API Endpoints

GET / will return the whole webring.

GET /id will return info about the node with the id id.

GET /id/neighbors will return info about the left and right node.

GET /id/random will return a random node that isn't the id, or the id's neighbors.

Usage Static-Sites

You can easily show your webring through placing javascript in your <head> tag and then creating a div. in your HTML file:

<script type="module" src="https://sitring.eric.si/webring.js?id=YOUR_ID_HERE" id="webringjs"></script>

It is important that you have the script ID as "webringjs" in order to query your ID succesfully. Additionally, you must have an element with ID "webring" in order to sucessfully output your webring links. Here is an example:

<!DOCTYPE html>
<html lang="en">
  <head>
    <script
      type="module"
      src="https://sitring.eric.si/webring.js?id=YOUR_ID_HERE"
      id="webringjs"
    ></script>
  </head>

  <div id="webring">
    <!-- the webring will automatically appear here -->
  </div>
</html>

Styling

Everything rendered within a static site will be within a <p> tag, in order to style your webring use the following in your CSS file:

#webring p {
  /*css here*/
}

Other stuff

MIT License

This is a webring run by the stevens students, this is in no way an endorsement from the institution in any way shape or form to any people in this ring. We're simply students.

About


Languages

Language:Rust 53.6%Language:JavaScript 44.9%Language:Dockerfile 1.5%