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
   

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.

• 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.

• Backend: Python
• NLP Frameworks: NLTK, Spacy
• Frontend: streamlit
• Database: Milvus lite
• Deployment: Docker, Cloud services for scalability

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.

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.

• Project Repository
• Project Discussions
• Documentation
• Introduction
• Architecture Diagrams
• BSCE
• DoS
• Docker
• Jupyter
• Mamba
• Scout

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

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

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

cd csusb_fall2024_cse6550_team2

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

git pull origin main

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

docker build -t team2_app .

Note: Use Mistral API Key in place of MISTRAL_API_KEY here below

docker run -d -p 5002:5002 -p 6002:6002 -e API_KEY=MISTRAL_API_KEY  team2_app

Development : App - http://localhost:5002/team2/ Jupyter - http://localhost:6002/team2/jupyter

Production : App - https://sec.cse.csusb.edu/team2/ Jupyter - https://sec.cse.csusb.edu/team2/jupyter

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.