ClassifAI

ClassifAI enhances educational content by transcribing video and audio into text for user modification and categorizes questions, offering engagement insights and user-friendly access.

Visit the Portal »

Documentation · Report Bug · Request Feature · Project Information

---

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact

About The Project

ClassifAI is a web application that enhances educational content by transcribing video and audio into text for user modification and categorizes questions, offering engagement insights and user-friendly access.

Built With

• React JS (Frontend)
• D3 + VisX (Visualization)
• Express JS (Backend)
• MongoDB (Database)
• Docker (Deployment)
• AWS Cognito (Deployment)

This connects to the ClassifAI Engine that handles the transcription and classification of the videos.

Getting Started

To get a local copy of this site up and running follow these simple steps.

More detailed instructions can be found in the documentation.

Prerequisites

• Node.js
• MongoDB
• Docker

Installation

1. Clone the repo

git clone https://github.com/TCU-ClassifAI/classifAI

For Frontend:

2. Install NPM packages

cd frontend
npm install

3. Run the frontend development server

npm run dev

4. (Optional) Build the project for deployment

npm run build

For Backend:

2. Install NPM packages

cd backend
npm install

3. Run the backend

npm run dev

For Database:

1. Install MongoDB
2. Run MongoDB

mongod

Roadmap

• Add more features to the dashboard
  • Word Clouds
  • Automatic Question Categorization via NLP
  • Question Categorization via User Input
  • Identify student questions that are not answered in the video
  • Identify students that are struggling with the content
  • Give a summary of the video
  • Give a summary of the questions
• Update the User Experience
  • Add Google Authentication for login
  • Streamline the process of uploading videos
  • Add a way to upload videos from YouTube
  • Add a way to upload videos from Zoom

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Learn About the Team

Project Link: https://github.com/TCU-ClassifAI/classifAI

More info about AI work being done at TCU: https://ai.tcu.edu/

Check out the documentation for more information about the project!

(back to top)