TeachMe is a mentor-mentee finder app that helps connect people seeking mentorship with experienced professionals in their field of interest. The app allows users to create profiles and search for mentors or mentees based on various criteria.
-
User Registration and Profile Creation: Users can sign up for an account and create their profile, providing information about their background, interests, and expertise.
-
Mentor Search: Users can search for mentors based on specific criteria such as industry, skills, location, availability, etc. They can browse through mentor profiles and view detailed information about their experience, qualifications, and mentoring preferences.
-
Messaging and Communication: The app provides a messaging system that allows mentors and mentees to communicate and arrange mentoring sessions. Users can schedule meetings, and discuss mentoring topics within the app.
-
Feedback and Ratings: After a mentoring session, users can provide feedback and ratings to each other, helping to build a reputation system within the app and assist other users in finding reliable mentors or mentees.
- Front-end: React.js, Next.js (a React framework), Clerk (for authentication), Tailwind CSS (for styling)
- Back-end: Clerk (for authentication)
- Database: Clerk (for authentication)
- Authentication: JSON Web Tokens (JWT)
- Deployment: Vercel
To run the TeachMe app locally, follow these steps:
- Clone the repository:
git clone https://github.com/bellapd/teachme.git
- Navigate to the project directory:
cd teachme
- Install dependencies:
npm install
- Set up the required environment variables (database connection, authentication, etc.).
- Start the development server:
npm run dev
- Open your browser and visit
http://localhost:3000
to access the TeachMe app.
TeachMe is an open-source project, and contributions are welcome. If you have any suggestions, improvements, or bug fixes, please submit a pull request or open an issue on the project's GitHub repository.
Before contributing, please review the contribution guidelines for detailed information on the development process, coding conventions, and other relevant guidelines.
- [Annabella Putri Dirgo]
- [Jansen Yuanda]
- [Jason Theodorus]
- [Vincent Leon]
- [Fernando Mikael]