kungfuchicken
commented
1 year ago sounds like a good plan. thx!
Open thehabes opened 1 year ago
kungfuchicken
commented
1 year ago sounds like a good plan. thx!
A markdown page for those interested in contributing to T-PEN. The main use case is the Open Source Center at SLU through which students can contribute to open source projects.
The goal is to make it possible for a new programmer to have a place to start in the code. From a top level, I think this forks into to two main paths of entry, Interfaces and Servlets.
T-PEN's greatest contribution to the internet is the Linked Open Data it produces, stores and makes available. The T-PEN 2.8 distribution does this with Java Classes, a bulk of which are HTTPServlets mapped by a web.xml document Spring and Struts style. The data is stored in a MySQL database. The proper data is queried for by a Servlet or Class then reconfigured as JSON-LD by that class, then sent on in the body of a HTTPServletResponse to clients.
T-PEN's greatest use case is Line by Line Transcription of Manuscripts. The response from the Java servlets is processed by Javascript middleware that builds it into a HTML User Interface. Users can set up projects based off of particular manuscripts then build teams around those projects for transcribing all pertinent lines on pertinent pages. Project Management, User Management, Admin Reports, and Transcription interfaces exist to give users the controls necessary to do all this. Those interfaces interact with existing Servlets to take data from a user in the interface to the MySQL database, and then back when necessary.
I believe trying to represent both of those forks under one specific diagram may be too difficult. I think we need individual diagrams for each of these forks to properly guide a new developer to where they should begin in the code.