Welcome to Mammoth Course Compass's Documentation!

This project is made possible through i2i (Ideas 2 Innovation) initiative, a student-led venture accelerator, at Amherst College.

Overview

Mammoth Course Compass aims to provide an anonymous way for Amherst students to review courses and professors, and simultaneously read reviews to inform course scheduling decisions.

Getting Started

To clone the app, run in terminal:

git clone https://github.com/ac-i2i-engineering/mammoth-course-compass.git
cd mammoth-course-compass

Set up a virtual environment and activate it to "containerize" the dependencies:

python3 -m venv env
source env/bin/activate

To run the app locally, run:

pip install -r requirements.txt
cd mammoth_course_compass_backend
python manage.py makemigrations
python manage.py migrate
python manage.py runserver

Contents

Contents:

• Course Model
• Course Rating Model

Additional Resources

For more information on how to contribute, report issues, or request features, please refer to our [GitHub repository](https://github.com/ac-i2i-engineering/access-amherst).