MENTOR ME NOW APP

Table of Contents

• About Project
• Built With
• Tech Stack
• Key Features
• Getting Started
  • Prerequisites
  • Setup
  • Install
• Usage
• Kanban Board
• Authors
• Future Features
• Contributing
• Show your support
• Acknowledgements
• License

About Project

MentorMeNow is a web application designed to connect mentees with experienced mentors across various fields. Our app streamlines the process of finding and scheduling sessions with mentors, facilitating personal and professional growth.

Built With

• React
• Vite
• TailwindCSS

Tech Stack

• React
• Redux Toolkit
• Vite
• TailwindCSS

Key Features

Mentor Discovery

• Browse Mentors: Users can explore a comprehensive list of mentors, gaining insights into their expertise.
• Mentor Profiles: Access detailed profiles of each mentor, including experience, and areas of specialization, skills, and hourly fees for mentoring sessions.

User Accounts

• Easy Signup/Login: Secure signup and login process using usernames, allowing users to access personalized features and manage their mentoring activities.

Mentorship Sessions

• Appointment Scheduling: Seamlessly book appointments with mentors of your choice, based on your preferences.

Collaborative Features

• Add/Remove Mentors: Users can contribute to the platform by adding new mentors to the list. Similarly, users can suggest the removal of mentors as needed, maintaining the quality and relevance of the mentor pool.

Getting Started

Prerequisites

• Node.js v18 minimum
• npm or yarn
• Access to the MentorMeNow Backend app running locally. --- See MentorMeNow Backend repository for more details

Setup

1. Clone this repository

git clone https://github.com/martinkarugaba/mentor_me_now_front_end.git
cd mentor_me_now_front_end

2. Install dependencies

npm install
# or
yarn install

Install

After cloning the repo and moving into the project directory, install the dependencies:

npm install
# or
yarn

Usage

Start the development server:

npm run dev
# or
yarn dev

Open http://localhost:5173/ to view it in your browser.

Ensure the MentorMeNow Backend app is running to fetch data successfully. For details on running the MentorMeNow Backend app, refer to its README.

Kanban Board

• Kanban board link
• Kanban board initial state
• We are a team of 3 members as indicated in the authors section

Authors

• Martin Karugaba - @martinkarugaba
• Ayokunnumi Omololu - @Ayokunnumi1
• Nelly Telli - @lily4178993

Future Features

• Implement proper user authentication from the front-end to the server.
• Implement features for Administrator user.
• Make sure that the "Add item" and "Delete item" links are accessible only by users who are admins
• Enhance UI/UX with animations.

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if this project helped you!

Acknowledgements

• MentorMeNow Backend for providing the API
• Murat Korkmaz for the original design on Behance
• Microverse
• React Documentation
• TailwindCSS Documentation
• Vite Documentation

License

This project is MIT licensed.

(back to top)