Giter Club home page Giter Club logo

freementors's Introduction

Build Status Coverage Status Maintainability

FREE MENTORS WEB APPLICATION

Table of content

  • Description
  • project Setup
  • Technology used
  • Routes
  • Relative links

Description

  • Free mentors is web application where Mentees can request mentorship sessions to Mentors,
  • Users can signup and singin to web application
  • Admin can change user to mentor,
  • Users can view mentors and view a specific mentor,
  • Mentors can accept or reject mentorship request from mentees,
  • Mentees can review Mentors after mentorship,
  • Admin can delete review.

Project setup

  1. Clone the project with git clone https://github.com/erickyvand/freeMentors.git
  2. Change directory with cd freeMentors in terminal
  3. Install packages with npm run npm install <package-names>
  4. run the applicaion with npm start

TECHNOLOGY USED

The APIs ENDPOINTS was developed using: NodeJS

ROUTES

Endpoint Methods Functionality
/api/v1/auth/signup POST User signup
/api/v1/auth/signup POST User signin
/api/v1/mentors GET View all mentors
/api/v1/mentors/:mentorId GET View specific mentor
/api/v1/user/:userId PATCH Change user to mentor
/api/v1/sessions POST Request Session
/api/v1/sessions/:sessionId/accept PATCH Accept request
/api/v1/sessions/:sessionId/reject PATCH Reject request
/api/v1/sessions GET View session request
/api/v1/sessions/:sessionId/review POST Review mentor
/api/v1/sessions/:sessionId/review DELETE Delete Review
/api/v1/users GET View all users

Relative links

  1. Heroku v1: https://the-free-mentors.herokuapp.com/
  2. gh-pages: https://erickyvand.github.io/freeMentors/UI/
  3. Heroku v2: https://the-freementors.herokuapp.com/
  4. Swagger: https://the-freementors.herokuapp.com/api-docs/

freementors's People

Contributors

erickyvand avatar dependabot[bot] avatar

Watchers

James Cloos avatar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.