Skip to content

Home

Jump to bottom
Jahnavi24csusb edited this page Oct 8, 2024 · 52 revisions

Welcome to the Academic Chatbot Advisor Project Wiki

This repository, csusb_fall2024_cse6550_team2, is dedicated to the development of an Academic Chatbot Advisor for students at California State University, San Bernardino (CSUSB). This project leverages modern technologies, including Natural Language Processing (NLP) and Artificial Intelligence (AI), to build a virtual assistant that helps students navigate their academic journey efficiently.

  1. Project Overview
  2. Key Features
  3. Technologies Used
  4. Development Phases
  5. Contributions
  6. Useful Links
  7. Setup

1. Project Overview

The Academic Chatbot Advisor is an AI-driven system designed to assist students by answering questions related to:

  • Course selection and prerequisites
  • Academic planning and scheduling
  • Graduation requirements
  • General university policies and FAQs

The chatbot provides 24/7 academic assistance, helping students make informed decisions about their academic progress.

2. Key Features

  • Natural Language Processing (NLP): Enables the chatbot to understand and respond to student queries in a conversational manner.
  • Personalized Assistance: Tailored recommendations based on student academic records and history.
  • GPA Calculation: Provides real-time GPA calculations based on student grades.
  • Integration with University Systems: Securely accesses academic databases to offer personalized advice.

3. Technologies Used

  • Backend: Python
  • NLP Frameworks: NLTK, Spacy
  • Frontend: HTML, CSS, JavaScript
  • Database: SQL/NoSQL for student data management
  • Deployment: Docker, Cloud services for scalability

4. Development Phases

  1. Phase 1: Basic chatbot implementation for handling FAQs.
  2. Phase 2: Integration with student databases for personalized academic advice.
  3. Phase 3: Advanced NLP features for complex academic queries and suggestions.

5. Contributing

We welcome contributions from all team members. Please refer to the Contribution Guidelines to learn more about how to participate in this project.

  • Step 1: Clone the repository.
  • Step 2: Create your own branch.
  • Step 3: Submit a pull request after testing your code.

6. Useful Links

7. Setup

Step 1: Clone the Repository

First, clone the GitHub repository to your local machine using the command below:

git clone https://github.com/DrAlzahraniProjects/csusb_fall2024_cse6550_team2.git

Step 2: Navigate to the Project Directory

Once the repository is cloned, navigate to the project directory:

cd csusb_fall2024_cse6550_team2

Step 3: Update the Local Repository

Ensure your local repository is up-to-date by running:

git pull origin main

Step 4: Build the Docker Image

Make sure Docker is installed and running on your machine. Build the Docker image using the following command:

docker build -t team2-app .

Step 5: Run the Docker Container

Windows - Make sure the Docker Desktop application is open on your local machine.

Run the Docker container to start the application. Use the command below:

docker run -p 80:80 -p 5002:5002 -p 6002:6002 team2-app

You can access the application at: http://localhost/team2 or http://127.0.0.1:5002/ or http://localhost:5002/

For further details on the project goals, architecture, or technical stack, feel free to explore the other wiki pages or reach out through the discussion board.

Clone this wiki locally