oh-online

Office Hours online to help TAs and students during this time of remote learning

TODO: Place sketch of application here

TOC

1. Getting Started
   1. Accessing the source code
   2. Prerequisites
   3. Project Structure
   4. Zoom OAuth Application
   5. Frontend
   6. Backend
2. System Design
3. Testing
   1. The Importance Of Automation
   2. Testing Strategy
   3. Unit Testing
   4. Integration Testing
   5. Component Testing
   6. Contract Testing
   7. End To End Testing
   8. The Test Pyramid
4. Deployment
   1. Kubernetes
   2. CI / CD (TBD)
5. Tools We Use
6. Contributing
7. Author
8. License

Getting Started

Accessing the source code

git clone https://github.com/bayoumi17m/oh-online.git

Prerequisites

Run locally

• Python >= 3.6
  • Poetry
• Node 12.16
  OR
• Docker v19.03 (Docker will install everything for you)

Cloud Deployment

• AWS:
  • Terraform
  • kops
  • kubectl

Project Structure

Create Zoom Application

Frontend

Backend

System Design

Testing

The Impoartance of Automation

Testing Strategy

Unit Testing

Integration Testing

Component Testing

Contract Testing

End to End Testing

The Test Pyramid

Deployment

Kubernetes

Tools we use

• Poetry: Automatric python package management and version resolution
• Github Actions / Travis CI (TBD)
• Code Climate
• Terrafom
  • kops

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, the process for submitting pull requests to us, and our code review guideline.

Authors

Magd Bayoumi - - bayoumi17m
Cora Wu - - cjw322
Rishabh Sarup - - risky998
Jerry Sun - - JSun14
Raye Liu - - Raye2333

License

This project is maintained under MIT license