Home

Welcome to the csusb_fall2024_cse6550_team3 wiki!

About Project

The textbook Chatbot project for CSE 6550 is designed to assist with queries related to the textbook "Software Engineering: A Practitioner's Approach." The chatbot serves as an educational tool, helping users by providing information, answering questions, and possibly retrieving content from the textbook.

Table of Contents

• Features
• Getting Started
• Contributing
• FAQ
• Community and Support
• Contact

Features

• Content Search and Navigation
• Personalized Learning Paths
• Interactive Q&A

Getting Started

Cloning :

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

Project directory :

cd csusb_fall2024_cse6550_team3 

Updating local repo :

git pull origin main 

Build docker image :

docker build -t team3-app .

Running docker container:

docker run -p 83:83 -p 5003:5003 -p 6003:6003 team3-app

FAQ

1. What is this chatbot designed to do?

   This chatbot is designed to assist users with answering questions from SE Textbook.

2. How do I interact with the chatbot?

   You can interact with the chatbot by following the above instructions on how to install, once you have the docker image built you can directly ask questions on the chatbot which uses Streamlit UI.

3. What platforms does the chatbot support?

   The chatbot can be deployed on your local system and used in almost all browsers like Brave, Chrome and Edge.

4. How can I customize the chatbot?

   You can customize the chatbot by customization instructions.

5. What technologies were used to build the chatbot?

   The chatbot was built using a lot of different technologies to make it functional and efficient, we have used Langchain for the backend, Streamlit for the frontend and Mistral as our core LLM

6. What should I do if the chatbot doesn’t respond?

   If the chatbot doesn’t respond, try troubleshooting steps.

7. How do I report bugs or issues?

   You can report bugs or issues by creating a new issue on the GitHub issues page from here or contact the project manager from the given email below

8. Can the chatbot handle multiple users?

   Yes, the chatbot is designed to handle multiple users simultaneously.

9. Is there a limit to the number of questions I can ask?

   No, there is no limit to the number of questions you can ask.

Community and Support

Click here for technical and non technical discussions

Contact

Project Manager: Fruzsina Ladanyi, 008455051@coyote.csusb.edu