Jajabenit250 / Free-Mentors

Free Mentors is a platform where people (Mentee) to request free mentorship with mentors.

Free-Mentors

Free Mentors is a platform where people (Mentee) to request free mentorship with mentors.

SETTING UP ENVIRONMENT

$ brew install node

check if it's available

$ node -v

you must have also git client

$ git --version

now clone repo

$ git clone https://github.com/Jajabenit250/Free-Mentors.git

Install dependencies

with npm

npm install

Start the server

 $ npm start

Tests & Linting

for running test do

 $ npm test

for linting do

$ npm lint

API ENDPOINTS

BASEURL : /api/v1/

AUTHENTICATION END POINTS : /auth/

HTTP METHOD	END POINT	AUTHENTICATED	DESCRIPTION
POST	/signup	False	Create a New User
POST	/signin	False	Authenticate The User

USER End POINT

HTTP METHOD	END POINT	AUTHENTICATED	DESCRIPTION
PATCH	/user/:id	True	Change User To Mentor

MENTORS End POINTS

HTTP METHOD	END POINT	AUTHENTICATED	DESCRIPTION
GET	/mentors	False	Get all Mentors
GET	/mentors/:id	False	Get mentor profile by id

SESSIONS End POINTS

HTTP METHOD	END POINT	AUTHENTICATED	DESCRIPTION
POST	/sessions	True	user create mentorship request
GET	/sessions	True	lists of mentorship requests
PATCH	/sessions/:id/accept	True	mentor accept mentorship session
PATCH	/sessions/:id/reject	True	mentor accept mentorship session
POST	/sessions/:id/review	True	Add a Review to session
DELETE	/sessions/:id/review	True	Delete a session review

Heroku

The application API is hosted on Heroku: https://free-mentors-benit.herokuapp.com/documentation/

Github Pages

The application UI is hosted on this gh-pages URL: https://jajabenit250.github.io/Free-Mentors/

Developer

Benit Havugimana <[e-mail]>