Skip to content
@UPenn-MOSA-Hackathon-Gang-of-Three

UPenn MOSA Fall 2022 Hackathon Gang of Three

Penn-Pal

Penn-Pal

Penn-Pal

Project summary

We developed a mentor matching software targeted towards online students (mentors and mentees) as well as mentor program administrators. Penn-Pal provides an intuitive and simple portal for mentors and mentees from different locations, time zones, backgrounds, and experiences to sign-up and connect with each other. Mentor program administrators can use the application on a desktop or mobile device to create a new mentoring event, and customize mentor-mentee matches.

Include the link to your Devpost project page here: Devpost

Check-out the online version here: https://penn-pal.vercel.app/

Authors

We are a group of three UPenn MCIT Online students who are participating in the MOSA Fall 2022 Hackathon.

Usage

Online live version (No installation required - Open in your web brower):

Home Page: https://penn-pal.vercel.app/

Create Mentor Event: https://penn-pal.vercel.app/event/new

Event Created Successfully: https://penn-pal.vercel.app/event/success?eventName=Test+event&id=12&uniqueID=GxoXxTB0exc6kHR4WaQwy

Mentor/Mentee Application: https://penn-pal.vercel.app/event/register

Meet your new mentor: https://penn-pal.vercel.app/event/status/24/tp5dQyDf8S6FIjuVMGE23

Coming Soon: https://penn-pal.vercel.app/coming-soon

Oops: https://penn-pal.vercel.app/oops

Prerequisites

Installation for Front-end

Step 1: Download WebStorm IDE

https://www.jetbrains.com/webstorm/download/#section=mac

Step 2: Download Node.js (version > 16.10)

https://nodejs.org/en/download/

Step 3: Type in your (MacOS) Terminal, to install yarn package

sudo npm install --global yarn

You can check if yarn is installed.

yarn --version

Deployment

Step 1: Download the front-end code from penn-pal-frontend

Step 2: Load the code into WebStorm https://www.jetbrains.com/help/webstorm/opening-reopening-and-closing-projects.html

Step 3: In the Terminal in WebStorm, make sure you have all the updated yarn packages.

yarn install

Screen Shot 2022-09-12 at 4 30 18 PM

Step 4: To run the code.

yarn dev

Screen Shot 2022-09-12 at 4 30 45 PM

Step 5: Program Administrator - Go to http://localhost:3000 with your browser to see the Program Administrator Mentor Program Event creation view.

Program Administrator - Home Page http://localhost:3000 Screen Shot 2022-09-12 at 4 31 17 PM

Program Adminstrator - Create an event http://localhost:3000/event/new

Screen Shot 2022-09-12 at 4 32 04 PM

Fill out all the required feeds in the Event Creation form and click on the "Create event" button on the bottom of the page http://localhost:3000/event/success?eventName=Mentor+event&uniqueId=12345

Screen Shot 2022-09-12 at 4 38 33 PM

Step 6: Mentee - Go to http://localhost:3000/event/register with your browser to see the Mentor and Mentee sign-up form.

Screen Shot 2022-09-12 at 4 33 49 PM

Click on Mentee Icon to get to Mentee Sign-up form (questions customized for mentee) - http://localhost:3000/event/register

Screen Shot 2022-09-12 at 4 34 19 PM

Fill out the application and then click on "Submit application" button on the bottom of the page. - http://localhost:3000/event/success?participantName=Ben&id=2&uniqueID=12345

Screen Shot 2022-09-12 at 4 35 45 PM

Step 7: Mentor - Go to http://localhost:3000/event/register with your browser to see the Mentor and Mentee sign-up form.

Screen Shot 2022-09-12 at 4 33 49 PM

Click on Mentor Icon to get to Mentor Sign-up form (questions customized for mentor) - http://localhost:3000/event/register

Screen Shot 2022-09-12 at 4 36 38 PM

Fill out the application and then click on "Submit application" button on the bottom of the page. - http://localhost:3000/event/success?participantName=Ben&id=2&uniqueID=12345

Screen Shot 2022-09-12 at 4 35 45 PM

Step 8: Found a Match page: Go to http://localhost:3000/event/status/1/yP3tp-C7vOndxThHVpD6o

Screen Shot 2022-09-12 at 6 35 23 PM

Step 9: To terminate Penn-Pal, in the Webstorm Terminal type "Control + C"

^C

Screen Shot 2022-09-12 at 4 44 49 PM

Optional:

To install the backend, please refer to the ReadMe in them penn-pal-testdatagenerator repository

To install the test data generator, please refer to the ReadMe in them penn-pal-testdatagenerator repository

Additional information

Tools used

To develop Penn-Pal, we used a host of technologies and tools to enable a feature-complete experience for the user:

Front-end:

Back-end:

Test Dataset Generator:

Penn-Pal (17)

License

MIT License

Copyright (c) 2022 Penn-Pal

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, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

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

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Popular repositories Loading

  1. hackathon-resources hackathon-resources Public

    Forked from mcitosa/hackathon-resources

    Resources for MOSA hackathon events

  2. .github .github Public

    1

  3. penn-pal-frontend penn-pal-frontend Public

    The frontend of the Penn-Pal App for matching mentees with mentors via an effective algorithm

    TypeScript 1

  4. penn-pal-backend penn-pal-backend Public

    The backend of the Penn-Pal App for matching mentees with mentors via an effective algorithm

    TypeScript

  5. penn-pal-testdatagenerator penn-pal-testdatagenerator Public

    Python

Repositories

Showing 5 of 5 repositories
  • .github Public
    UPenn-MOSA-Hackathon-Gang-of-Three/.github’s past year of commit activity
    0 1 0 0 Updated Sep 13, 2022
  • penn-pal-frontend Public

    The frontend of the Penn-Pal App for matching mentees with mentors via an effective algorithm

    UPenn-MOSA-Hackathon-Gang-of-Three/penn-pal-frontend’s past year of commit activity
    TypeScript 0 MIT 1 0 0 Updated Sep 13, 2022
  • UPenn-MOSA-Hackathon-Gang-of-Three/penn-pal-testdatagenerator’s past year of commit activity
    Python 0 MIT 0 0 0 Updated Sep 13, 2022
  • penn-pal-backend Public

    The backend of the Penn-Pal App for matching mentees with mentors via an effective algorithm

    UPenn-MOSA-Hackathon-Gang-of-Three/penn-pal-backend’s past year of commit activity
    TypeScript 0 MIT 0 0 0 Updated Sep 13, 2022
  • hackathon-resources Public Forked from mcitosa/hackathon-resources

    Resources for MOSA hackathon events

    UPenn-MOSA-Hackathon-Gang-of-Three/hackathon-resources’s past year of commit activity
    0 13 0 0 Updated Aug 8, 2020

Top languages

Loading…

Most used topics

Loading…