Skip to content

Latest commit

 

History

History
142 lines (102 loc) · 4.5 KB

README.md

File metadata and controls

142 lines (102 loc) · 4.5 KB

Project Title

CLOGBLOG (Blog App) Client Side

Screenshots

App Screenshot App Screenshot App Screenshot

Authors

Logo

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

API Reference

User signup

   POST /api/v1/users/signup
Parameter Type Description
username string Required. Your user name
email string Required. Your email address
password string Required. Your given password
passwordConfirm string Required. Your password confirmation

User login

   POST /api/v1/users/login
Parameter Type Description
email string Required. Your email address
password string Required. Your given password

User Update Data

   PATCH /api/v1/users/updateMe
Parameter Type Description
username string Required. Your user name
fullname string Required. Your full name
email string Required. Your email address
id string Required. Your user id
photo file Not Required. Your image
cloudinary_id string Not Required. photo cloudinary id

Change Password

  PATCH /api/v1/users/updateMyPassword
Parameter Type Description
currentPassword string Required Users current password
password string Required. Users password
passwordConfirm string Required. Users password Confirmation

Get all Posts

  GET /api/v1/post
Parameter Type Description
jwt string Required. Your jwt token

Get Single Post

  GET /api/v1/post/${id}
Parameter Type Description
id string Required. Id of post to fetch
jwt string Required. Your jwt token

Create Post

  POST /api/v1/posts
Parameter Type Description
jwt string Required. Your jwt token
title string Required. Your post title
description string Required. Your post description
categories Array Not Required. Your post categories
photo file Not Required. Your post photo

Update Post

  PATCH /api/v1/post/${id}
Parameter Type Description
id string Required. Id of post to update
jwt string Required. Your jwt token
title string Required. Your post title
description string Required. Your post description
categories Array Not Required. Your post categories
photo file Not Required. Your post photo

Delete Post

  DELETE /api/v1/posts/${id}
Parameter Type Description
id string Required. Id of post to delete
jwt string Required. Your jwt token

Documentation

Documentation