SETUP_README.md

ClassPortal API

Internal REST API for [ClassPortal][classportal].

Built with [Node.js][nodejs], [TypeScript][typescript], [Restify][restify], and [Mongoose][mongoose].

Table of Contents

• High-level App Summary
• DB Dependency Logic
• Bootstrapping Instructions
• Contribute

## High Level App Summary ## DB Dependency Logic

1. A SuperAdmin user must be created on the basis of the SuperAdmin username in the .env file. The username must match the Github login username.