CS493 Final Project Team 1

Team Members

• Tom Nyuma
• Jeff Huang
• Artem Kolpakov
• Alaric Hartsock

Project Description

For our final project, we're building an API from scratch. The API we'll be building is Tarpaulin, a lightweight course management tool that’s an “alternative” to Canvas. In particular, Tarpaulin allows users (instructors and students) to see information about the courses they’re teaching/taking. It allows instructors to create assignments for their courses, and it allows students to submit solutions to those assignments.

Getting Started

Prerequisites

Before getting started with developing or testing Tarpaulin, you'll need to install the following:

• Docker
• Docker Compose
• Node.js
• NPM
• Insomnia
• MongoDB

Installation

1. Clone the repo

   git clone https://github.com/osu-cs493-sp23/DreamTeamDB.git

2. Install NPM packages

   cd DreamTeamDB && npm install

3. Start the dockcer containers

docker-compose -f services.yml up -d --force-recreate 

--force-recreate flag is optional

4. Start the server (dev)

   npm run dev 

• OpenAPI Spec
• Swagger.io

Tech Stack

• Node.js
• Express
• MongoDB
• Redis
• JsonWebToken
• Joi
• Bcrypt
• Insomnia
• Docker Compose

Entity Relationship Diagram