Skip to content

RedJanvier/elite-members-api

Repository files navigation

elite-members-api

DeepScan grade Build Status Coverage Status Maintainability

This is a REST API based on Node Js, Express, Postgresql, and JWT for authentication which deals with managing and maintaining members of a class group called Elite.

Features to implement

  • Member should be able to Join the group
  • Member should be able to leave the group
  • Member should be able to update his/her informations
  • Anyone should be able to get all details of any member
  • Anyone should be able so see all members of the group
  • Member (committee) should be able to log into his/her group account

Routes

  • See all members
[GET] /api/v2/members/

:body: none
  • See a single member
[GET] /api/v2/members/:id

:body: none
  • Signin a members
[POST] /api/v2/members/signin

:body: {
    email "STRING",
    password "STRING"
}
  • Create a members (require signin)
[POST] /api/v2/members/create

:body: {
    name "STRING",
    email "STRING",
    shares "INTEGER",
    location "STRING",
    img "URL",
    committee "STRING" (optional),
    password "STRING"
}
  • Edit a member (require signin)
[PATCH] /api/v2/members/:id

:body: (updates_only) {
    name "STRING",
    email "STRING",
    shares "INTEGER",
    location "STRING",
    img "URL",
    committee "STRING" (optional),
    password "STRING"
}
  • Remove a members
[DELETE] /api/v2/members/:id

:body: none

Tech stack

  • Node JS
  • Express JS
  • PostgreSQL
  • knex
  • bcrypt
  • jsonwebtokens

Author

RedJanvier

Contacts

Github Twitter YouTube Facebook

About

This is a REST API based on Node Js, Express, Postgresql, and JWT for authentication

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published