MyCourseIndex

MyCourseIndex is a project for CS/INFO 4300: Language and Information that acts as an essential search engine for Cornell students and their courses with the initial goal to improve the Piazza search user experience. This search gathers all information from Piazza posts to Textbook and Notes Resources and returns valid results for the student to utilize. It is now being maintained by members of the Cornell Data Science Project Team. Currently, the MCI team is workng on a Q&A system for students and also created a new sign on page for Professors to enroll their courses into the system.

Links

Note: You must have a Cornell Email to utilize this website due to security reasons.

• Website Link: www.mycourseindex.com
• Prototype 2: v2.mycourseindex.com {Deprecated}
• Prototype 1: v1.mycourseindex.com {Deprecated}
• Documentation: docs.mycourseindex.com

Preview

TOC

1. Getting Started
   1. Accessing the source code
   2. Prerequisites
   3. Project Structure
   4. Backend
   5. Frontend
2. System Design
3. Deployment
   1. Kubernetes
4. Contributing
5. Author
6. License

Getting Started

Accessing the Source Code

bash
git clone

Prerequisites

• Python v3.7.6
• AWS Cloud account
• Poetry

Project Structure

Describe structure of project in terms of generic folders and poetry (and other python tools) usage

Backend

poetry install
poetry run python app.py

Website should be on browser @ localhost:5000

Frontend

cd client
yarn install
yarn build
cd ..

System Design

Deployment

Using GitOps (explain more)

Kubernetes

Piazza Search leverages Kubernetes to automate deployment, scaling, and management of containerized microservices.

TODO: Image of the Kubernetes structure

Author

1. Magd Bayoumi (mb2363)
2. Jenna Kressin (jek343)
3. Souleiman Benhida (sb2342)
4. Sheetal Athrey (spa42)
5. Oscar So (ons4)
6. David Kim (jk2537)
7. Jessie Lee (sl994)
8. Julia Ng (jen67)
9. Katie Yang (ky289)
10. Elva Gao (yg357)
11. John O'Donnell (jro79)