Java Transcript Web App Back End Product Overview

My Role

This is an in-progress solo project.

Project Description

This is the Java version of the back end for the online port of my company's VB database, which is used for transcript production and workflow management. The VB database does everything from scheduling to automated shorthand to automated hyperlinking and document formatting, shipping, production, management of company financials, and other business operations, and this back end was designed and created to support a front end that also does such things. It currently contains fake sample data and still needs certain endpoints added to it, but is fully functional. Copyright 2020 Erica Ingram.

Key Features

• Live solo project
• RESTful API with auth services for transcript production system
• 138 (400+ when complete) endpoints
• CourtListener, Xero, PayPal, Wunderlist, & Office API support
• Tested and documented via Postman & JUnit
• IN PROGRESS

Tech Stack

Back end deployed to Heroku and built using:

• Java: a programming language.
• SQL: a domain-specific language used in programming and designed for managing data held in an RDBMS or stream processing in an RDSMS
• Java Spring: Spring provides everything required beyond the Java programming language for creating enterprise applications for a wide range of scenarios and architectures.
• JUnit 4: a simple framework to write repeatable tests; an instance of the xUnit architecture for unit testing frameworks.
• SLF4J: a simple logging facade for Java.
• OAuth2: industry-standard protocol for authorization
• Swagger: simplifies Java API documentation.
• PostgreSQL: open-source relational database supporting both SQL & JSON querying.
• Maven: software project management & comprehension tool.

API

• CourtListener: assists in automation of authority hyperlinking.
• Office: document creation, formatting, and management.
• PayPal: payment processing and management.
• Wunderlist: to-do list management.
• Xero business accounting software online.

Testing

• The endpoints in the Java back end are being tested with JUnit 4.

Documentation

DB SCHEMA | BASE URL | PRODUCT VISION | ENDPOINTS | FRONT END (still in planning stages)

POSTMAN DOCUMENTATION | SWAGGER DOCUMENTATION | SAMPLE RESPONSE

CUSTOMER USE CASE DIAGRAM | MANAGER USE CASE DIAGRAM

See also a Node version of this API.

• All endpoints have been documented via Postman and Swagger.
• Postman Docs were last published on 09/05/2020.
• Postman docs contain examples of all get, post, and put endpoint body submissions AND responses.