Update for Modern Implementations (#75)

* Get these pieces right * GH logos * GH logos * GH logos * GH logos * http to https updates. links to TinyThings and RERUM API documentation. * Add CONTRIBUTING, link to it from README * touch up readme * touch up contributing * Java is now NodeJS * Update readme.md * Update readme.md * dev cards * Dev cards, shorter readme blurbs, audience added to readme blurbs * Dev cards, shorter readme blurbs, audience added to readme blurbs * touch ups * type the code snippets * touch up * changes from deep read * changes from deep read * changes from deep read * changes from deep read * open source statement * open source statement * os statement here too * no need for important * Changes requested from @cubap review * as as
CenterForDigitalHumanities · Nov 6, 2023 · f961855 · f961855
1 parent 9fb3361
commit f961855
Show file tree

Hide file tree

Showing 11 changed files with 154 additions and 104 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# Contribute to the RERUM Website
+```
+██████╗ ███████╗██████╗ ██╗   ██╗███╗   ███╗
+██╔══██╗██╔════╝██╔══██╗██║   ██║████╗ ████║
+██████╔╝█████╗  ██████╔╝██║   ██║██╔████╔██║
+██╔══██╗██╔══╝  ██╔══██╗██║   ██║██║╚██╔╝██║
+██║  ██║███████╗██║  ██║╚██████╔╝██║ ╚═╝ ██║
+╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝ ╚═════╝ ╚═╝     ╚═╝
+```
+## ❤️ Thank You
+
+Thank you for considering a contribution to this site!  The `main` branch is protected and you cannot push to it. 
+
+You can always contact the developers:
+* [Patrick Cuba](https://github.com/orgs/CenterForDigitalHumanities/people/cubap), IT Architect. [email protected]  <br>![Github stats](https://github-readme-stats.vercel.app/api?username=cubap&theme=highcontrast&show_icons=true&count_private=true)
+* [Bryan Haberberger](https://github.com/orgs/CenterForDigitalHumanities/people/thehabes), Full-Stack Developer. [email protected] <br>![Github stats](https://github-readme-stats.vercel.app/api?username=thehabes&theme=highcontrast&show_icons=true&count_private=true)
+* [Research Computing Group at Saint Louis Univsersity](https://github.com/CenterForDigitalHumanities) -- [email protected]
+
+## Ready to Install It And Run It!
+
+OK!  This is a static website that can run straight off of your filesystem or from within any web server.  Make sure Git is installed on your machine.  You will use Git to install the website.
+
+Once you know where the website folder will be use Git to clone the website into that folder.
+
+```shell
+cd /code_folder/
+git clone https://github.com/CenterForDigitalHumanities/rerum.git rerum_website
+```
+
+Now you have main on your local machine and can open the HTML pages!  As you make changes, they will appear on these pages.
+
+## 🎉 Ready to Start Contributing!
+
+First, make a new branch through the [GitHub interface](https://github.com/CenterForDigitalHumanities/rerum/) or through your shell.  Make sure you 'checkout' that branch.
+
+```shell
+cd /code_folder/rerum_website
+git checkout my_new_branch
+```
+
+Now you can make code changes and see them in real time!  When you are finished with the commits to your new branch, open a Pull Request that targets the `main` branch at [https://github.com/CenterForDigitalHumanities/rerum/tree/main](https://github.com/CenterForDigitalHumanities/rerum/tree/main).
diff --git a/app/api/api.html b/app/api/api.html
diff --git a/app/app.css b/app/app.css
@@ -348,6 +348,18 @@ dd {
     }
 }
 
+os-statement {
+    position: fixed;
+    bottom: 4.25em;
+    padding: 0.25em 0.45em;
+    right: 0;
+    display: block;
+    background-color: #dfdfdf;
+    font-family: monospace;
+    font-size: 10pt;
+    font-weight: bold;
+}
+
 /* Larger than phablet */
 @media (max-width: 550px) {
     .card {
@@ -361,4 +373,9 @@ dd {
     footer {
         position: relative;
     }
+    os-statement{
+        position: relative;
+        bottom: 0;
+        text-align: center;
+    }
 }
diff --git a/app/cases/cases.html b/app/cases/cases.html
@@ -1,7 +1,7 @@
 <div class="container">
     <h1>Featured RERUM Users</h1>
     <ul>
-        <li><a target="_blank" href="http://tiny.rerum.io">Tiny Things</a></li>
+        <li><a target="_blank" href="https://tiny.rerum.io">Tiny Things</a></li>
         <li><a target="_blank" href="https://www.newberry.org/paleography">Newberry Library</a></li>
         <li><a target="_blank" href="https://brokenbooks.omeka.net/">Broken Books</a></li>
         <li><a target="_blank" href="https://www.biodiversitylibrary.org/">Biodiversity Heritage Library</a></li>

diff --git a/app/future/future.html b/app/future/future.html
@@ -62,8 +62,8 @@ <h3 id="server">Server</h3>
 
     <h3 id="api">API</h3>
     <p>
-        All instances of RERUM repositories must allow for at least the core API documented on
-        <a href="http://centerfordigitalhumanities.github.io/rerum_server/API.html" target="_blank"><i class="fa fa-github"></i> Github</a>.
+        All instances of RERUM repositories must allow for at least the core API documented at
+        <a href="https://store.rerum.io/v1/API.html" target="_blank"> https://store.rerum.io/v1/API.html</a>.
         Version 0 is currently deprecated suffering from several unconventional structures
         and a somewhat complex object structure. Version 1, currently in open release,
         standardizes the object structure, establishes versioning, and removes the model 

diff --git a/app/index.html b/app/index.html
@@ -44,6 +44,9 @@ <h1 class="ten columns">
     <ng-view></ng-view>
     <div style="height:20rem;width:100%;"></div>
     <footer>
+        <os-statement>
+            This site is open source.  <a target="_blank" href="https://github.com/CenterForDigitalHumanities/rerum">Improve this page</a>
+        </os-statement>
         <div class="row">
             <a href="#welcome" class="button column">
                 Home
@@ -87,5 +90,6 @@ <h1 class="ten columns">
     <script type="text/javascript" src="app/tools/parse-rect/parsing.js"></script>
     <script type="text/javascript" src="app/tools/crop-page/cropping.js"></script>
     <script type="text/javascript" src="app/tools/read-manifest/read.js"></script>
+
 </body>
 </html>
diff --git a/app/registration/connecting.html b/app/registration/connecting.html
@@ -4,22 +4,21 @@ <h1>Connecting to RERUM</h1>
     <p>
         To limit the possibility of abuse without putting too many obstacles up,
         writing to the annotation store is restricted to servers (no CORS) who have
-        <a href="http://store.rerum.io">registered themselves</a>. The full plans for RERUM can be found
+        <a href="https://store.rerum.io">registered themselves</a>. The full plans for RERUM can be found
         <a href="#/future">elsewhere on the site</a>.
     </p>
     <p>
         The current public RERUM service is hosted on
-        a virtual server of OngCDH at Saint Louis University.
-        The backend is written in Java and MongoDB, with all requests currently over
+        a virtual server at Saint Louis University and mainainted by the Research Computing Group.
+        It is a NodeJS Express App that connects to a cloud hosted MongoDB, with all requests currently over
         HTTP.
     </p>
     <p>
-        All read requests (GET) are open by default. To write to RERUM, you require
-        a registered server that is capable of using the API correctly. It may be
-        helpful to see the sample implementation of
-        <a href="http://tiny.rerum.io/">Tiny Things</a>
-        (<a href='https://github.com/CenterForDigitalHumanities/TinyThings'><i class="fa fa-github"></i></a>)
+        All read requests (GET) are open by default. To write to RERUM, you must register to acquire tokens.  One set of tokens represents one unique application.  You may need to register for multiple sets of tokens if you have multiple unique applications. It may be
+        helpful to see the sample implementation of <a href="https://tiny.rerum.io/">Tiny Things</a>
+        (<a href='https://github.com/CenterForDigitalHumanities/TinyNode'><i class="fa fa-github"></i></a>)
     </p>
-    <a class="btn btn-info" href="http://store.rerum.io">Register for the RERUM</a>
-    <a class="btn btn-info" href="http://centerfordigitalhumanities.github.io/rerum_server/">Read the API</a>
+    <a class="btn btn-info" href="https://store.rerum.io">Register to use RERUM</a>
+    <a class="btn btn-info" href="https://store.rerum.io/v1/API.html">Read the RERUM API</a>
+    <a class="btn btn-info" href="https://github.com/CenterForDigitalHumanities/rerum_server_nodejs#host-your-own">Host your own RERUM</a>
 </div>
diff --git a/app/welcome.html b/app/welcome.html
@@ -190,25 +190,25 @@ <h3>Our Subdominions</h3>
                 <dd>
                     The main website for all things in the Rerum ecosystem
                 </dd>
-                <dt><a href="http://store.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-cubes"></i> store.rerum.io</a></dt>
+                <dt><a href="https://store.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-cubes"></i> store.rerum.io</a></dt>
                 <dd>
                     The current release of the RERUM service (v1) with an 
                     open sandbox for <span class="no-break">developers at 
-                    <a href="http://devstore.rerum.io" target="_blank" rel="noopener noreferrer">devstore.rerum.io</a></span>
+                    <a href="https://devstore.rerum.io" target="_blank" rel="noopener noreferrer">devstore.rerum.io</a></span>
                 </dd>
-                <dt><a href="http://tiny.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-cube"></i> tiny.rerum.io</a></dt>
+                <dt><a href="https://tiny.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-cube"></i> tiny.rerum.io</a></dt>
                 <dd>
                     A minimum RERUM implementation for bootstrapping new applications quickly
                 </dd>
-                <dt><a href="http://deer.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-sitemap"></i> deer.rerum.io</a></dt>
+                <dt><a href="https://deer.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-sitemap"></i> deer.rerum.io</a></dt>
                 <dd>
                     A framework for designers to use RERUM with simple HTML
                 </dd>
-                <dt><a href="http://geo.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-globe"></i> geo.rerum.io</a></dt>
+                <dt><a href="https://geo.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-globe"></i> geo.rerum.io</a></dt>
                 <dd>
                     A web interface demonstrating GeoJSON-LD annotations in RERUM
                 </dd>
-                <dt><a href="http://inbox.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-bell"></i> inbox.rerum.io</a> (<a href="http://inbox-docs.rerum.io" target="_blank" rel="noopener noreferrer">inbox-docs.rerum.io</a>)</dt>
+                <dt><a href="httsp://inbox.rerum.io" target="_blank" rel="noopener noreferrer"><i class="fa fa-3x u-pull-left fa-bell"></i> inbox.rerum.io</a> (<a href="https://inbox-docs.rerum.io" target="_blank" rel="noopener noreferrer">inbox-docs.rerum.io</a>)</dt>
                 <dd>
                     The habitat for all Rerum LDN Inbox announcements (and its documentation and demos)
                 </dd>

diff --git a/embed.html b/embed.html
@@ -47,6 +47,9 @@ <h1 class="ten columns">
     <ng-view></ng-view>
     <div style="height:20rem;width:100%;"></div>
     <footer>
+        <os-statement>
+            This site is open source.  <a target="_blank" href="https://github.com/CenterForDigitalHumanities/rerum">Improve this page</a>
+        </os-statement>
         <div class="row">
             <a href="#welcome" class="button four columns">
                 Home

diff --git a/index.html b/index.html
@@ -44,6 +44,9 @@ <h1 class="ten columns ">
     <ng-view></ng-view>
     <div style="height:20rem;width:100%;"></div>
     <footer>
+        <os-statement>
+                This site is open source.  <a target="_blank" href="https://github.com/CenterForDigitalHumanities/rerum">Improve this page</a>
+        </os-statement>
         <div class="row">
             <a href="#welcome" class="button column">
                 Home

diff --git a/readme.md b/readme.md
@@ -10,32 +10,40 @@ reconditorium eximium rerum universalium mutabiliumque
 
 RERUM is a product of the Center for Digital Humanities at Saint Louis
         University and is (currently) completely funded and maintained by the
-        fine folks in the Researching Computing Group. This site is meant to be used by
-        developers and programmers who need a good place to put some data and
-        prefer that it be a public place that is not too expensive.
+        fine folks in the Researching Computing Group. RERUM is meant to be used 
+        as a place to encode, store, and present data
+        in a public place that is not too expensive.
 
 Our goal is to provide a simple, out-of-the box connection that reduces
         concerns and costs about data storage and management while making
         interoperability, standards compliance, and attribution automatic.
 
 Originally conceived as a "IIIF Store" (iiif.io), RERUM is designed to act as an
-open node for annotation and references that need to be made in an interoperable
-world of scholarly assertions.
+        open node for annotation and references that need to be made in an interoperable
+        world of scholarly assertions.
 
-This project is not only access to the existing instance, maintained and hosted by
-the Research Computing Group at Saint Louis University, but
-also the complete cut list for making your own. However useful this may be for private
-projects, applications in development, or because of funding requirements, we
-hope that your machine enjoys talking to others and releases its gnats of
-knowledge into the Interwebs.
+This site will direct you towards the existing public instance and detail how you can
+        create and host your own instance. However useful this may be for private
+        projects, applications in development, or because of funding requirements, we
+        hope that your machine enjoys talking to others and releases its gnats of
+        knowledge into the Interwebs.
 
-RERUM Install Information<br>
-To use your own instance RERUM, here are a few things to know:
+## Core Pieces of RERUM
+RERUM's existence as an interactive node on the web requires a software stack, and the pieces of that stack are all open source.
+Where and how you start to interact with RERUM depends on your specific needs and skills.
 
-   - RERUM is written in Java. 
-   - RERUM supports Java 1.6 and above. 
-   - RERUM uses MongoDB as its database. 
-   - RERUM uses HTTP protocol to do CRUD operations from the client. 
-   - RERUM doesn't support cross domain AJAX call, so the call must be initialized from a registered server. 
-   - HTTP requests must be open on port 80. 
+### [RERUM Informational Website](https://rerum.io) <a href='https://github.com/CenterForDigitalHumanities/rerum'>
+_YOU ARE HERE_ <img height="15" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png"/>.  This is a static web site hosted on GitHub Pages for typical web users looking for information and links.
+
+### [RERUM Client](https://tiny.rerum.io) <a href='https://github.com/CenterForDigitalHumanities/TinyNode'> <img height="25" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png"/></a>
+Formally known as TinyThings, this is a NodeJS client web application that is already set up to use the RERUM API.  This client app takes user input and makes requests to the RERUM API then processes the responses back into the UI.  It is of interest to software developers looking to build front end interfaces who do not want to set up their own back end.
+
+### [RERUM Client Sandbox API](https://store.rerum.io/v1/API.html#tldr-i-just-want-to-use-it) <a href='https://github.com/CenterForDigitalHumanities/TinyNode'> <img height="25" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png"/></a>
+As a registered RERUM application, TinyThings exposes its internal API as a publicly available API.  This gives applications the chance to use the RERUM API without signing up as an individual registered RERUM application.  This is most useful to a software developer when they already have a front end and just want to start using the RERUM API right away.  It is primed for "proof of concept" development stages.
+
+### [RERUM API](https://store.rerum.io/v1/) <a href='https://github.com/CenterForDigitalHumanities/rerum_server_nodejs'> <img height="25" src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png"/></a>
+Think of this like a typical bot.  The bot itself is a NodeJS Express web application that exposes API hooks - it waits for requests to do some action (create - delete - update - find), processes those requests, then responds to the web application that initiated those requests about what happened.  Back end software developers utilize the programmatic RERUM API for data transfer and storage.
 
+## 🌟👍 Contributors 👍🌟
+Click on the GitHub icon to go to the code repositories of the RERUM cores listed above.
+Trying to make a change to this website?  We appreciate it!  Head to the [Contributors Guide](CONTRIBUTING.md).