diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..cedc621
--- /dev/null
+++ 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. patrick.m.cuba@slu.edu
![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. bryan.j.haberberger@slu.edu
![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) -- research.computing@slu.edu
+
+## 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
index b40e869..6c5710d 100644
--- a/app/api/api.html
+++ b/app/api/api.html
@@ -7,13 +7,13 @@
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 - registered themselves. The full plans for RERUM can be found + registered themselves. The full plans for RERUM can be found elsewhere on the site.
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 is maintained by the Research Computing Group. + It is written in NodeJS and connects to a cloud hosted MongoDB, with all requests currently over HTTP.
@@ -75,7 +75,7 @@
All the following interactions will take place between the server running RERUM and the application server. Direct connection from client script to the RERUM server is not allowed. Please note that all @@ -84,19 +84,19 @@
If you would like to see an example of a web application leveraging the RERUM API visit the - testbed at http://tinydev.rerum.io or the GitHub codebase for TinyThings.
+ testbed at https://tinydev.rerum.io or the GitHub codebase for TinyThings.To have simple CRUD ability from client script without using a back end proxy, you can use our public test endpoints. Note: Your data will be public and could be removed at any time. This is for testing only and will not be attributed to you in any way.
Example: http://devstore.rerum.io/v1/id/11111
+Example: https://devstore.rerum.io/v1/id/11111
Example: http://devstore.rerum.io/v1/history/11111
+Example: https://devstore.rerum.io/v1/history/11111
Example: http://devstore.rerum.io/v1/since/11111
+Example: https://devstore.rerum.io/v1/since/11111
{JSON}
Location: http://devstore.rerum.io/v1/id/11111
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/11111
{JSON}
{JSON}
Location: http://devstore.rerum.io/v1/id/22222
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222
{JSON}
{JSON}
{
"code" : 200,
- "original_object_id" : "http://devstore.rerum.io/v1/id/11111",
+ "original_object_id" : "https://devstore.rerum.io/v1/id/11111",
"new_obj_state" : {
- "@id": "http://devstore.rerum.io/v1/id/22222",
+ "@id": "https://devstore.rerum.io/v1/id/22222",
"__rerum":{
"history":{
- "previous":"http://devstore.rerum.io/v1/id/11111",
+ "previous":"https://devstore.rerum.io/v1/id/11111",
...
}
...
}
...
- },
- "iiif_validation" : {
- "warnings" : ["Array of warnings from IIIF validator"],
- "error" : "Error for why this object failed validation",
- "okay" : 1 // 0 or 1 as to whether or not it passed IIIF validation
}
}
@@ -563,7 +553,7 @@ {JSON}
Location: http://devstore.rerum.io/v1/id/22222
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222
{JSON}
{
"code" : 200,
- "original_object_id" : "http://devstore.rerum.io/v1/id/11111",
+ "original_object_id" : "https://devstore.rerum.io/v1/id/11111",
"new_obj_state" : {
- "@id": "http://devstore.rerum.io/v1/id/22222",
+ "@id": "https://devstore.rerum.io/v1/id/22222",
"__rerum":{
"history":{
- "previous":"http://devstore.rerum.io/v1/id/11111",
+ "previous":"https://devstore.rerum.io/v1/id/11111",
...
}
...
}
...
- },
- "iiif_validation" : {
- "warnings" : ["Array of warnings from IIIF validator"],
- "error" : "Error for why this object failed validation",
- "okay" : 1 // 0 or 1 as to whether or not it passed IIIF validation
}
}
@@ -625,7 +610,7 @@ [{JSON}]
Location: http://devstore.rerum.io/v1/id/22222, ...
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222, ...
[{JSON}]
/patch.action
{JSON}
Location: http://devstore.rerum.io/v1/id/22222
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222
{JSON}
Location: http://devstore.rerum.io/v1/id/22222
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222
{
"code" : 200,
- "original_object_id" : "http://devstore.rerum.io/v1/id/11111",
+ "original_object_id" : "https://devstore.rerum.io/v1/id/11111",
"new_obj_state" : {
- "@id": "http://devstore.rerum.io/v1/id/22222",
+ "@id": "https://devstore.rerum.io/v1/id/22222",
"__rerum":{
"history":{
- "previous":"http://devstore.rerum.io/v1/id/11111",
+ "previous":"https://devstore.rerum.io/v1/id/11111",
...
}
...
}
...
- },
- "iiif_validation" : {
- "warnings" : ["Array of warnings from IIIF validator"],
- "error" : "Error for why this object failed validation",
- "okay" : 1 // 0 or 1 as to whether or not it passed IIIF validation
}
}
@@ -743,7 +723,7 @@ {JSON}
Location: http://devstore.rerum.io/v1/id/22222
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222
{JSON}
{JSON}
Location: http://devstore.rerum.io/v1/id/22222
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/22222
{JSON}
{JSON}
Location: http://devstore.rerum.io/v1/id/11111
+ class="language-plaintext highlighter-rouge">Location: https://devstore.rerum.io/v1/id/11111
{JSON}
{
- "@id" : "http://devstore.rerum.io/v1/id/11111",
+ "@id" : "https://devstore.rerum.io/v1/id/11111",
"__deleted" : {
"object" : {
- "@id" : "http://devstore.rerum.io/v1/id/11111",
+ "@id" : "https://devstore.rerum.io/v1/id/11111",
"@type": "sc:Canvas",
"label": "page 46",
"width": 730,
@@ -1082,7 +1057,7 @@ AuthenticationTinyThings.
+ href="https://github.com/CenterForDigitalHumanities/TinyNode/blob/main/tokens.js">TinyThings
.
The API key at Auth0 persists for each application, which may manage its own sessions. Expired
(unauthorized) sessions receive a 401 Unauthorized
response with instructions to refresh the session or to register the application.
diff --git a/app/app.css b/app/app.css
index f8235b7..f35cc7c 100644
--- 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
index 38d21fe..d1f2306 100644
--- a/app/cases/cases.html
+++ b/app/cases/cases.html
@@ -1,7 +1,7 @@
- All instances of RERUM repositories must allow for at least the core API documented on - Github. + All instances of RERUM repositories must allow for at least the core API documented at + https://store.rerum.io/v1/API.html. 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 index 542ba05..d056d5a 100644 --- a/app/index.html +++ b/app/index.html @@ -44,6 +44,9 @@