Skip to content

aaronkjin/mentore

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mentore

An AI search platform for mentors. Designed to connect you with the perfect mentor tailored to your unique needs, preferences, and aspirations. Offers personalized mentorship connections that can help propel your personal and professional growth.

Getting Started

Quick setup to get the site running:

# navigate to frontend directory
cd frontend

# run the application
npm start

Open http://localhost:3000 with your browser.

Walkthrough

Home Page

mentore-home

Initiate your mentor search on our Home Page, offering a clean, intuitive interface inspired by leading LLM applications. Navigation options, including mentor signup and site logo for easy home access, are provided at the top.

Auth Page

mentore-auth

Register or log in through the Auth Page to begin interacting with the platform and access more personalized features.

Mentor Sign-Up Page

mentore-signup

Aspiring mentors can register via the Mentor Sign-Up Page by clicking "Become a Mentor" and entering relevant details to join our mentor database. Enjoy the Easter egg featuring Gavin Belson in the placeholder text.

Chat Page

mentore-chat

The Chat Page delivers a sleek, minimalistic text-based interface for users to refine their search and interact with potential mentor matches through a backend-driven chatbot leveraging OpenAI embeddings and GPT-4.

Design

Backend

Engineered to process user queries through a JSON interface, leveraging OpenAI embeddings and GPT-4's computation capabilities. Analyzes user input to generate a compatible mentor match, outputting the results in a structured JSON format for the frontend to consume.

Frontend

Offers a digital interface with seamless user interaction, supporting information input and displaying rich mentor profiles for an efficient user journey.

Technologies Used

Backend

  • Flask (Python web framework)
  • OpenAI Python library
  • SciPy library (for spatial distance computations)
  • CSV module (for CSV file operations)
  • JSON module (for JSON parsing and response handling)

Frontend

  • JavaScript
  • HTML/CSS
  • React
  • Client-side data fetching and state management with React hooks

Data Handling and AI

  • Precomputed embeddings using OpenAI's embedding models
  • RESTful API endpoints (for querying and response handling)
  • Cosine similarity (for mentor matching logic)
  • GPT-4 (for generating mentor matches based on user queries)

Database

  • Firebase (to store mentors and auth details)

Contributing

We welcome contributions! If you're interested in helping improve Mentore, please fork the repository and submit a pull request with your proposed changes. For major changes, please open an issue first to discuss what you would like to change.

License

Not for public release. Do not copy, do not distribute.

Contact

For inquiries or further information, reach out to us at:

About

An AI search platform for mentors

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •