https://github.com/glowiep/smartagent-react
Customer support ticket management application, paired with an AI assistant.
https://github.com/glowiep/smartagent-react
Last synced: about 2 months ago
JSON representation
Customer support ticket management application, paired with an AI assistant.
- Host: GitHub
- URL: https://github.com/glowiep/smartagent-react
- Owner: glowiep
- Created: 2024-05-07T13:19:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-13T00:32:49.000Z (12 months ago)
- Last Synced: 2025-02-11T12:30:39.571Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 12.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SmartAgent 💬
SmartAgent is a customer support ticket management application, paired with an AI assistant.
## Goals 🏆
This is a 4-week collaborative final project by [Gloria Lim](https://github.com/glowiep) and [Sebastian Varon](https://github.com/svaronc).
The goals of this project was to:
- Leverage all the skills and knowledge learned throughout Lighthouse Labs Web Development Bootcamp
- Practice creating functional requirements, user stories, and wireframes.
- Build an application from start to finish, created with React (frontend) and Ruby on Rails (backend).
## Getting Started ✨
To run this project locally, clone this repository and navigate to the root directory.
### Requirements
- Ruby version 3.3.0
- NodeJS >= 18.15.0
Notes on the AI Chatbot on the Landing page created with [FlowiseAI](https://flowiseai.com/):
- The FlowiseAI chatbot on the landing page was hosted on Railway during the project demonstration.
- The FlowiseAI configuration can be replicated by importing the json file in planning/FlowiseAI into your Flowise project. The accompanying text file is the input document for the Text File Loader.
- Please see .env.example file in /frontend for the secret keys setup for the connection to the FlowiseAI project.
### Back-end 🚅
1. Navigate to the /backend folder.
2. Run ```bundle install``` to install dependencies.
3. Create config/database.yml by copying config/database.example.yml. Set up the database credentials in this file.
4. Run migrations with ```bin/rails db:migrate```.
4. If you want to recreate the database from scratch, run ```bin/rails db:reset``` to create, load and seed the database. Check step 3 if this returns an error.
5. Run ```bin/rails s -b 0.0.0.0``` to start the server
### Frontend 🚀
1. Navigate to the /frontend folder.
2. Install dependencies by running ```npm install```.
3. Run ```npm run dev``` to start the frontend server. It will run on http://localhost:5173
## Features ✅
SmartAgent has a landing page for Customers and SmartAgent users.
Customers can submit requests via the form on the landing page, or by emailing SmartAgent email directly.
There is also an AI chatbot on the landing page to assist with general questions regarding the SmartAgent application.
When a SmartAgent user is logged in, they can view the main application inbox:
Agents are able to chat within the application.
A SmartAgent user can transfer the ticket to another agent.
This is the ticket view.
The ticket notes can be viewed in the side panel that appears when you click on 'Ticket Notes'.
SmartAgents can send email responses directly in the ticket.
There is also a Dashboard with the SmartAgent's performance stats.
