JellyUp

A collaborative project developed d aimed at fulfilling/replicating the requirements of JellyJelly.com.

Report Bug ✱ Request Feature ✱ Documentation

Table of Contents

• Table of Contents
• Architecture Diagram
• Tech Stack
  • Backend
  • Frontend
  • Development Tools
  • Additional Tools
• Getting Started
  • Prerequisites
  • Installation
  • Usage
• License

Architecture Diagram

The architecture diagram above illustrates the general structure of the application and how each component interacts with one another. Please note that the architecture is subject to change as the project progresses.

Tech Stack

Backend

• Framework: Flask
• Machine Learning Libraries:
  • Transformers
  • OpenAI
  • DeepFace
• Audio and Video Processing:
  • Pydub
  • MoviePy
  • FFmpeg
• Database: Supabase

Frontend

• Framework: React (with Next.js)
• Styling: Tailwind CSS, ShadCN UI
• Animation: Framer Motion, Drei (for 3D animations with React Fiber)
• TypeScript
• Node.js

Development Tools

• Containerization: Docker
• Package Management: Poetry, npm
• Deployment: Vercel

Additional Tools

• Image Search: Pexels API (for retrieving images based on queries, maybe not applied at the time of your reeading this)
• Natural Language Processing: NLTK (for sentiment analysi, maybe not applied at the time of your reeading this)

Getting Started

This guide provides step-by-step instructions on how to set up the application on your local machine for development and testing purposes.

Prerequisites

Ensure you have the following installed on your machine:

• Node.js
• npm
• Git
• Vercel CLI
• Next.js
• ffmpeg
• axios
• Prisma
• ESLint

Installation

1. Clone the repository:

git clone https://github.com/NautilusAI/Customer-Support-AI.git .

Note: The . at the end of the command clones the repository into the current directory instead of creating a new directory.

2. Navigate to the frontend directory and install the dependencies:

cd ./frontend
npm install

3. You can now run the application locally. It is recommended to use the run.cmd command to start the application:

.\run.cmd

Alternatively, you can start the application using:

npm run dev

If you prefer not to use npm, you can also use yarn, pnpm, or bun:

yarn dev
# or
pnpm dev
# or
bun dev

Note: If you encounter issues, please check the package.json file for the correct command.

Usage

To access the application, navigate to:

http://localhost:3000

NOTE: All applications build using Next.js will usually run on port 3000, but this can be changed within the next.config.js file.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.