Free-Mentors

Free Mentors is a social initiative where accomplished professionals become role models to young people to provide free mentorship sessions.

Getting Started

These are steps that should be followed by anyone who want toget a copy of project

The project is composed of two different sections:

• User Interface
• API

Requirements

• User intrface

  • Any Web Browser (We recommend using Google Chrome)

  • Text Editor (VSCode is highly recommende)

  • User inteface login credential for mentor and admin

    For admin

    • Email :[email protected]
    • password :admin

    For mentor

    • Email :[email protected]
    • password :mentor

• API Endpoints

  • Node JS
  • Postman

Features

• Required Features
  1. Users can sign up.
  2. Users can sign in.
  3. Admin can change a user to a mentor.
  4. Users can view mentors.
  5. Users can view a specific mentor.
  6. Users can create a mentorship session request with a mentor.
  7. A mentor can accept a mentorship session request.
  8. A mentor can decline a mentorship session request.
• Optional Features
  1. Users can view all their mentorship sessions.
  2. Users can review a mentor after a mentorship session.
  3. Admin can delete a review deemed as inappropriate.

API

• Required API

  1. POST /auth/signup
  2. POST /auth/signin
  3. PATCH /user/:userId
  4. GET /mentors
  5. GET/mentors/:mentorId
  6. POST/sessions
  7. PATCH /sessions/:sessionId/accept
  8. PATCH /sessions/:sessionId/reject

• Optional

  1. GET /sessions
  2. POST /sessions/:sessionId/review
  3. DELETE /sessions/:sessionId/review

• use git bash:

  1. First download git bash
  2. Install it
  3. Clone it by running git clone https://github.com/ngirimana/Free-Mentors.git
  4. Find the project directory from where you are tunning the git bash.

Installing

1.For running the api

1. First download and install Node JS
2. Download and install Postman
3. Clone the project. free-mentors
4. Run npm install (sudo apt install for linux users) command for installing all project dependencies

Running the tests

1. Open command prompt
2. navigate to the directory of cloned project
3. Run the automated test by running npm run test command

Running the UI Template

• Just run index.html from the cloned project
• OR simply use gh-page to run Free-Mentors UI

Running API

• Heroku link
• API documentation

Used tools

• Server
  • Server side Framework: Node JS/Express
  • Linting Library: ESLint
  • Style Guide: Airbnb
  • Testing Framework: Mocha
  • Documentation Tools: Swagger
  • postgres:postgress

• User interface

  • CSS
  • HTML
  • JS

Author

NGIRIMANA Schadrack

License

LICENCE - LICENSE

Acknowledgments

• Andela Kigali