utsavshukla0509 / blog-site

Blog-Site

Build an application to display blog articles

Table fo Contents

1. User SignUp
   
2. User SignIn
   
3. User Profile
   
4. Publish
   
5. Home
   
6. Get Articles By Tag
   
7. Commands Available
   

1. Create User Account

   POST   /user/signup

     Request Body : {
       	"username" : "xyz",
           "age" : 23,
           "email" : "[email protected]",
           "password" : "xyz"
     }
   
   Response : {
       The user has been signed up successfully!
   }
   

2. User SignIn

   POST   /user/login

   Request Body : {
       "email" : "[email protected]",
       "password" : "xyz"
   }
   
   Response : {
       "msg" : "Authentication has been successful",
       "token" : "JWT_TOKEN"
   }
   

3. User Profile

   GET   /user/:username

   Authorization: "Beaver JWT_TOKEN"
   
   Response : {
       "data" : userData,                  // User profile info. is stored in data
       "articles" : userArticles;          // All the articles he/she published is stored in articles 
   }
   

4. Publish Article

   POST   /blog/publish

   Authorization: "Beaver JWT_TOKEN"
   
   Response : {
       "description" : "",                 // Article description is stored in description
       "captionTagList" : ""               // All the tags related to an article stored in captionTagList 
   }
   

5. Home Info

   GET   /blog/home

   Authorization: "Beaver JWT_TOKEN"
   
   Response : {
       "articles" : []                     // All the newest to oldest articles based on sorting are stored in this articles list
   }
   

6. Get Articles By Tag

   GET   /tags/:tagname

   Authorization: "Beaver JWT_TOKEN"
   
   Response : {
       "articleData" : []                   // All the articles which have given "tagname" are stored in this articleData list
   }
   

7. Commands Available

   node server.js or nodemon  // to run the node server
   npm test                  // for checking Unit Tests