Skip to content

CapitalOneCanadaHackathon/MentorMatcher

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Application

System requirements

You need to install Docker, Java, Maven, postgres (from homebrew)

Before

Run sh init.sh

Run application

Run sh run.sh

To connect to postgres, use psql -h localhost -p 5432 -U pguser and input password

Health check

Endpoint http://localhost:8080/health

Method GET

Sample curl -v http://localhost:8080/health

To register a new customer with the system

Endpoint http://localhost:8080/registernewcustomer

Method POST

Data format JSON

Sample

curl -H "Content-Type: application/json" -d '{"firstName":"Jack","lastName":"Smith", "education": "professional", "isEducator": true, "programTrack": "mentor", "grade": null, "fieldOfStudy": null, "province": "Ontario", "gender": "male", "isIndigenous": true, "comments": "Has won olympic math awards."}' http://localhost:8080/registernewcustomer

curl -H "Content-Type: application/json" -d '{"firstName":"Rosey","lastName":"Johnson", "education": "highschool", "isEducator": false, "programTrack": "mentee", "grade": 11, "fieldOfStudy": "music", "province": "Ontario", "gender": "female", "isIndigenous": true, "comments": "Is looking for someone to tutor her."}' http://localhost:8080/registernewcustomer

To validate

psql> \connect postgres
psql> \dt
psql> SELECT * FROM customer;

To get a list of all customers

To get those who are mentees and in high school

curl http://localhost:8080/gethighschoolmentees

To get those who are mentees and in post-secondary

curl http://localhost:8080/getpostsecondarymentees

To get those who are mentees and educators

curl http://localhost:8080/geteducatormentees

To get matches of customers

Endpoint http://localhost:8080/gettopfivematches

Method POST

Sample curl -H "Content-Type: text/plain" -d "1" http://localhost:8080/gettopfivematches

To make a match for a pair of customers

Endpoint http://localhost:8080/pairmatches

Method POST

Sample curl -H "Content-Type: application/json" -d '{"mentorId":"1", "menteeId":"3"}' http://localhost:8080/pairmatches

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 51.1%
  • Shell 48.9%