Skip to content

NodeJS, PostgreSQL & Express API for my company's transcript mgmt app, live solo project based on db from "vbDatabase" repo

Notifications You must be signed in to change notification settings

evoingram/webapp-backend

Repository files navigation

Maintainability

Transcript Web App Back End Product Overview

My Role

This was a solo project.

Project Description

This is 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
  • 126 endpoints
  • CourtListener, Xero, PayPal, Wunderlist, & Office API support
  • Tested and documented via Postman

Tech Stack

Back end deployed to Heroku and built using:

  • Node.js: a JavaScript runtime.
  • Knex: a query builder for PostgreSQL, MySQL and SQLite3, designed to be flexible, portable, and fun to use.
  • Express: a fast, unopinionated, minimalist web framework for Node.
  • bcrypt: modern(-ish) password hashing for your software and your servers.
  • PostgreSQL: open-source relational database supporting both SQL & JSON querying.

Available Scripts

npm server

npm start

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

  • All endpoints have been tested and documented via Postman.

Documentation

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

See also a Java version of this API in progress.

  • Postman Docs were last published on 04/08/2020.
  • Postman docs contain examples of all get, post, and put endpoint body submissions AND responses.

About

NodeJS, PostgreSQL & Express API for my company's transcript mgmt app, live solo project based on db from "vbDatabase" repo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published