CP3407 Project Assignment
Group 10 - ChatBot
Welcome to the repository for the JCU Orientation Chatbot, an interactive chatbot designed to assist new students starting their orientation at James Cook University [ JCU ]. Instead of searching through the extensive JCU website, students can get instant answers to their orientation-related questions from one place. This chatbot is built using JavaScript, HTML and JSON to create a seamless and engageing experience for students. It is designed to be integrated directly into the JCU website, providing real-time support for queries about campus resources, orientation schedules, student services and more.
Installation
-
Clone the repo
git clone https://github.com/github_username/CP3407-ChatBot.git -
Install all dependicies found in package.json
npm install package.json -
Get a free API Key at [https://platform.openai.com/api-keys] (Or an API Key similar to OpenAI functions)
-
Enter your API keys in .env
const OPENAI_KEY = 'ENTER YOUR OPENAI API KEY'; -
Run the chatbot locally and test on a browser
Diagrams
UML Diagram: Architectural Design
<img src="src/static/images/UML Diagram .png" alt="UML Diagram architecture" width="900" height="400">Database Diagram
<img src="src/static/images/Database diagram.png" alt="Database Diagram" width="600" height="400">Interface Design
Figma link: https://www.figma.com/design/BGEPXBb8GCTDC5aP8mm0oy/CP3407---ChatBot?node-id=0-1&t=8VRnPmGRHFEjSC7x-1
<img src="src/static/images/Full page design.png" alt="Full Figma Design" width="700" height="400"> <img src="src/static/images/Skeleton.png" alt="Wireframe of Figma Design" width="700" height="400">Features
University-Specific Responses
🏫 Provides accurate information related to JCU's orientation program
Web-Based
💻 Easily accesible via JCU website