Skip to content

sks147/hnbg

Repository files navigation

HNBG

Steps to run the application

  • git clone https://github.com/sks147/hnbg.git
  • cd hnbg
  • npm install
  • npm run dev

API examples

For authenticating and getting user information x-auth-token is required in requests.

Register New user Register New User


Get User Info by token Get User Info by token


Authenticate User Authenticate User


Create/Update User Profile Create/Update User Profile


Get Logged in User Profile Get Logged in User Profile


Get All articles

  • Fetches the top 90 articles from Hackernews API.
  • Updates or creates the articles in the Database. Get All articles

Get Individual Article Get Individual Article


Sample UI Sample UI


Mark Article as Read

  • Adds the current article to the read_articles list in user profile
  • By clicking on Mark As Read Button we can call the api to read article api
  • In frontend we can check if the article is present in read_articles list we can show it as read Mark Article as Read

Delete the Article for Logged in User Profile

  • Adds the current article to the deleted_articles list in user profile
  • By clicking on Delete Button we can call the api to delete article api
  • In frontend we can check if the article is present in deleted_articles list we can hide it from user Delete the Article for Logged in User Profile

Postman Collection

Postman Collection

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors