MentE

MentE is an app built for educational organizations with mentorship programs. Mentees sign up for the app, choose from a list of pre-approved mentors, and get matched with one by our algorithm. Mentors sign up for the app to give back without busy work and red tape. The app tracks the meetings between pairings, allowing administrators to quickly notice high-quality mentors for repeat involvement and trim low-quality mentors.

Table of Contents

1. Getting Started
   • Requirements
   • Installation
   • Database Setup and Seeding
2. Running the Project
3. Tech Stack
4. Potential Features
5. Credits
6. License

Getting Started

Requirements

Be sure you've installed:

1. Ruby 3.4.1
2. Rails 7.2.2.1
3. PostgreSQL 14.15
4. Bundler 2.5.14
5. (Optional) If you're running this on a Windows machine, you should set up WSL2. Here's a guide on getting it running.

Installation

1. First, clone the repo to your machine:

git clone https://github.com/DPI-Group-Project/MentorshipPlatform.git

2. Next, navigate to the repo in your terminal, then install the required ruby gems with the bundle command:

bundle

Database Setup and Seeding

3. Ensure you have an active PostgreSQL connection, then create your database and run your Rails migrations. We've also seeded a consistent first user and program to simplify admin testing. You can create, migrate, and seed the database with one command:

rails db:prepare

4. Run the sample data task to populate your new local database:

rails sample_data

Running the Project

5. Start the Rails server.

rails s

6. Visit http://localhost:3000 to view the application in your browser of choice.

Tech Stack

This is a Ruby on Rails project with a PostgreSQL backend. The MentE team chose this stack because we all learned it in Discovery Partners Institute's Software Development Apprenticeship. Each contributor has also built at least one solo project with this tech stack, so we felt very comfortable with it.

Potential Features

• In the future, with tools like Hotwire Native, it should be possible to take our hard work and port it to a mobile app.
• Check back for more use cases

Credits

This app has been a labor of love from 10 dedicated software developers, project managers, designers and more. These contributors are listed in no particular order. Learn more about our team here:

• Aizat Ibraimova (LinkedIn) — Project Manager
• Natalie Demyanenko (LinkedIn) — Scrum Master, DevOps, Back-End Developer
• Young Song (LinkedIn) — UI/UX Designer, Front-End Developer, Back-End Developer
• Jennifer Rahman (LinkedIn) — UI/UX Designer, Front-End Developer
• Arpan Patel (LinkedIn) — UI/UX Designer, Front-End Developer, Back-End Developer
• Brandon Varner (LinkedIn) — Front-End Developer, Back-End Developer, Team Lead
• Maya Sheriff (LinkedIn) — Back-End Developer, Team Lead
• Benny Joram (LinkedIn) — Back-End Developer
• Reza Husain (LinkedIn) — Back-End Developer
• Fadi Baker (LinkedIn) — Sales

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, subject to the following conditions:

1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

2. Any commercial use of derivative works based on this Software requires prior written approval from the the MentE team (those credited above).