Home

1. What is SHELF?

A platform for students, build by students. It was created as a part of internship under Hasura. The need for SHELF was felt when we finished our first year and were trying to sell off our books. This is when I started writing it with Amey Parundekar in my hostel room.

2. Database model

The above image shows the schema we are using for our app. There are 3 views and 8 tables.
PS. The above illustration is generated using DbDesigner.

3. Documentation

Back-end is written in node.js and the front-end is written in angular.
The back-end endpoints can be divided into two categories:

• Authorization
• Data

3.1 Authorization

• 3.1.1 Login

  type: POST
  route: /login
  body: username, password
  response: 200, Logged in
            403, Invalid credentials
            500, Bad request
  

• 3.1.2 Logout

  type: GET
  route: /logout
  response: 200, Logged out
            403, Please login first