StudyBuddy

Class: CS 3354.002
Professor: Srimathi Srinivasan
Team: Team 6 — StudyBuddy

Team Members

• Robert Teal
• Drashti Shah
• Harsh Patel
• Nicholas Gover
• Vinay A. Nair
• Luke Nelson
• Sanah Singh
• Sai Abhinav Pydimarry

StudyBuddy - Local Setup

🛠️ Prerequisites

Make sure you have the following installed:

• Python 3.8 + (https://www.python.org/downloads/)
• Node.js & npm(https://nodejs.org/en/download)
• Virtual Environment (recommended for Python)

🚀 Getting Started

In Command Prompt or Terminal, clone the repository to your computer:

1️⃣ Clone the Repository

git clone https://github.com/your-username/StudyAssist.git

Navigate to the project folder cd StudyAssist

Then, you will open two terminals: frontend and backend

Backend

Commands to run

- cd backend 
- pip install -r requirements.txt
- cd StudyBuddy_django
- python manage.py runserver 

Django will run at: http://127.0.0.1:8000/ to ensure that it is working correctly

Frontend

Commands to run

- cd StudyAssist
- npm install
- npm run dev

Commands to run for installing UI libraries (if any errors appear)

npm install date-fns
npm install lucide-react
npm install @radix-ui/react-tabs
npm install @radix-ui/react-switch
npm install @radix-ui/react-tooltip
npm install @radix-ui/react-select
npm install @radix-ui/react-checkbox
npm install @radix-ui/react-label
npm install @radix-ui/react-radio-group
npm install @radix-ui/react-separator
npm install @radix-ui/react-progress
npm install @radix-ui/react-slot

After installing these packages successfully:

React app will run at: http://localhost:3000/