Skip to content

Commit 1d5e6bd

Browse files
Merge pull request #145 from oss-slu/portfolio-rerum-playground
Portfolio updation
2 parents c921c6b + 2a5250b commit 1d5e6bd

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

docs/project_rerum_playground/about.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ This is a web space that uses the RERUM installation at the Walter J. Ong, S.J.
1111
### Information
1212

1313
- **Source Code:**
14-
- https://github.com/CenterForDigitalHumanities/rerum-playground [<img src="/img/git-alt.svg" alt="git" width="25" height="25" />](https://github.com/CenterForDigitalHumanities/rerum-playground)
14+
- https://github.com/oss-slu/rerum-playground [<img src="/img/git-alt.svg" alt="git" width="25" height="25" />](https://github.com/oss-slu/rerum-playground)
1515

1616
- **Client**
1717
- Patrick Cuba [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/cubap)
1818
- Bryan Haberberger [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/thehabes)
1919

20-
- **Current Tech Lead:** Lalith Adithya Reddy Avuthu [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/alar12)
20+
- **Current Tech Lead:** Lalith Adithya Reddy Avuthu [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/alar12)[<img src="/img/linkedin.svg" alt="linkedin" width="25" height="25" />](https://www.linkedin.com/in/lalith-adithya-reddy-avuthu-1a409b192/)
2121

2222
- **Developers:**
23-
- Bryan Haberberger [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/thehabes)
24-
- Patrick Cuba [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/cubap)
2523
- Haneen AlSewari [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/haneenalsewari)
2624
- Hayden Karl [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/haydenkarl22)
2725
- Samuel Sheppard [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/sesheppard)
26+
- Bryan Haberberger [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/thehabes) (alumni)
27+
- Patrick Cuba [<img src="/img/github.svg" alt="github" width="25" height="25" />](https://github.com/cubap) (alumni)
2828

2929
- **Start Date:** June 2020
3030
- **Adoption Date:** Aug 2024
@@ -38,8 +38,15 @@ This is a web space that uses the RERUM installation at the Walter J. Ong, S.J.
3838

3939
#### Rerum Playground
4040

41-
A web based application with a set of tools (existing) integrated in a playground to interact with objects that may exist in RERUM and all over the internet. After user logs in, The tools are helpful with transcription, annotation, Geolocator ( Providing a URI and picking point coordinates for that) etc.. This playground encourages users to freely experiment with these tools and it builds their confidence around them. They don't have to worry about their work saving in linked open land unless they want it to be saved.
41+
RERUM Playground is a web-based toolset enabling users to work with IIIF manifests and JSON-LD objects. Users can bring their own manifest or create one within the playground, then use the listed tools to visualize, edit, and redirect the manifest to other compatible applications.
42+
43+
#### Overview
44+
This project allows users to create, interact with, and manage IIIF-compliant JSON-LD objects, with an intuitive interface.
45+
46+
#### Key Features
47+
Manifest Handling: Import or create IIIF manifests.
4248

49+
Tool Integration: Choose tools to interact with manifests, redirecting to compatible applications.
4350

4451
## Technical Information
4552

@@ -49,14 +56,13 @@ Overview of the software architecture.
4956

5057
![Architecture](./architecture.png)
5158

52-
The playground utilizes a layered architecture consisting of a front end user interface written in HTML and JavaScript, middleware in Node.js (or other), a back end server, and an external API system provided by RERUM. The front end allows user interaction and displays the interface. It passes user input to the middleware layer which processes requests and routing between the front and back end. The back end server receives requests from the middleware, makes calls to the RERUM API to execute data operations based on the request, gets the response from RERUM indicating the result, processes the response, and passes it back to the middleware. The middleware then forwards the response to the front end user interface layer to display the results to the user. This layered architecture with the front end, middleware, server, and external API allows the full user interaction flow and application capabilities.
59+
The "RERUM Playground" project is a web application designed to interact with the RERUM API. It consists of various components organized into frontend, services, and static assets. The frontend includes HTML, CSS, and JavaScript files to display and manage the user interface, such as tools, manifests, and configurations. The project also uses services like manifest storage and tool management, ensuring smooth user interaction and functionality. Static assets such as images and styles are stored separately. The GitHub repository for this project is [here](https://github.com/oss-slu/rerum-playground), and it follows a well-structured approach to maintain all code and assets within designated folders like web/js for scripts and web/images for visuals. This structure ensures the application is modular, easy to maintain, and scalable.
5360

5461
### Development Priorities
5562

56-
- A need for authentication
5763
- A sharable playground. Every tool should have a link to share their work build with that.
58-
- An option to save the users work (If they really want to keep it) built with a tool.
59-
- Rerum tools page. (That lists and explains all the tools)
64+
- An option to upload/fetch the users manifest files (If they want to edit/start a new manifest we are building a manifest editor for that).
65+
- Rerum tools page.
6066
- CI/CD Workflows
6167

6268
## Get Involved
710 KB
Loading

0 commit comments

Comments
 (0)