Skip to content

anslemkelechi/social-media-app

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SOCIAL_MEDIA_APP

A social media application in the likeness of twitter but for developers in mind.


Stack

Language : Javascript(nodejs) Database: PostgreSql, MySql


Basic Features

  • Register a new account(JWT & social authentication)
  • Login to account (JWT & social authentication)
  • Publish a new post
  • Like a post
  • Comment on a post
  • Share user profile
  • Upload images and videos to posts
  • Follow other users on the platform
  • Share/repost a post
  • Edit& Delete a post
  • Delete account
  • View all users
  • Block all users
  • Unblock users
  • Delete user
  • Unpublish post
  • Messaging & rooms

User

field data_type constraints
email string required, unique
username string required, unique
displayName string required
password string required
confirm_password string required

Social authentication

  • Github Route: /auth/github
  • Google Route: /auth/google
  • Method: GET

Signup User

  • Route: api/v1/users/signup
  • Method: POST
  • Body:
{
    "email":"'[email protected]",
    "password": "secret",
    "confirm_password": "secret",
    "displayName": "bandu",
    "username":"bandu"
}
  • Responses

Success

{
    "status": "Success",
    "data": {
        "user": {
            "id": 18,
            "email": "'[email protected]",
            "displayName": "bandu",
            "username": "bandu",
            "updatedAt": "2023-02-16T16:38:24.498Z",
            "createdAt": "2023-02-16T16:38:24.498Z"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxOCwiaWF0IjoxNjc2NTY1NTA1LCJleHAiOjE2ODQzNDE1MDV9.JNJcO0kr-k6xiwIW4WBm7oO8TcuebSBTV1bIowM40lU"
    }
}



update display name

  • Route: api/v1/users/:userId
  • Method: PATCH
  • Body:
{
    "displayName":"colos"
}
  • Responses

Success

{
  "status": "Success",
  "data": {
    "updatedUser": {
      "id": 2,
      "githubId": null,
      "googleId": null,
      "email": "[email protected]",
      "username": "adejo",
      "displayName": "colos",
      "passwordToken": null,
      "passwordResetExpires": null,
      "deletionDate": null,
      "createdAt": "2023-03-02T22:37:03.000Z",
      "updatedAt": "2023-03-03T19:39:17.636Z"
    }
  }
}

Login User

  • Route: api/v1/users/login
  • Method: POST
  • Body:
{
    "email":"[email protected]",
    "password": "secret"
}
  • Responses

Success

{
    "status": "Success",
    "data": {
        "user": {
            "id": 16,
            "githubId": null,
            "googleId": null,
            "email": "[email protected]",
            "username": "jojo",
            "displayName": "josiah",
            "passwordToken": null,
            "passwordResetExpires": null,
            "createdAt": "2023-02-16T15:14:20.000Z",
            "updatedAt": "2023-02-16T15:14:20.000Z"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxNiwiaWF0IjoxNjc2NTYwODY1LCJleHAiOjE2ODQzMzY4NjV9.c1iHVw8HdBhBZXWiuyUeqVoSiqu9UHkhbMNUBqnhrdk"
    }
}

Request Account Deactivation

  • Route: api/v1/account/delete

  • Method: PATCH

  • Responses

Success

{
    "status": "success",
    "message": "A link has been sent to your mail. Please check your mail to continue.
}

Deactivate Account

  • Route: api/v1/account/deactivate

  • Method: PATCH

  • Responses

Success

{
    "status": true,
    "message": "Your account has been deactivated, and will be permanently deleted after 30days of inactivity. Thanks"
}

Get Profile - When deactivated

  • Route: /api/v1/profiles/profile/ssamuel

  • Method: GET

  • Responses

Success

{
    "status": "success",
    "message": "This account is deactivated",
    "data": {
        "profile": {
            "username": "Samuel",
            "displayName": "Korku",
            "Bio": "A normal user",
            "website": null,
            "location": null,
            "github_link": null,
            "twitter_link": null,
            "avatarURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1677003471/urtw4ionpp5i8e6knkft.jpg",
            "headerURL": "https://cdn.pixabay.com/photo/2016/08/30/16/26/banner-1631296__340.jpg",
            "followers": null,
            "isdeactivated": true
        }
    }
}

NOTE: SOME FIELDS LIKE website, github_link, twitter_link AND location, WILL RETURN 'null' WHEN THE AN ACCOUNT IS DEACTIVATED


Get Profile - When deactivated

  • Route: users/login
  • Method: POST
  • Body
  { 
    "email" : "[email protected]",
    "password" : "Kelechi123"
}

  • Responses
{
    "status": "Fail",
    "error": {
        "statusCode": 400,
        "status": "Fail",
        "isOperational": true,
        "level":"ďż˝[31merrorďż˝[39m",
        "timestamp": "2023-02-21 21:06:06:66"
    },
    "message":"ďż˝[31mYour account is presently deactivated! ďż˝[39m\nďż˝[31m  Click http://localhost:3310/api/v1/account/activate to activateďż˝[39m"
}

Get Activate Account

  • Route: account/activate
  • Method: GET
  • Responses
{
    A FORM PAGE FOR EMAIL AND PASSWORD FOR NORMAL USERS, AND OAUTH FOR SOCIAL USERS 
}

Activate account

  • Route: account/activate
  • Method: PATCH
  • Body
  { 
    "email" : "[email protected]",
    "password" : "Kelechi123"
}

  • Responses
{
    "status": "Success",
    "data": {
        "user": {
            "id": 6,
            "githubId": null,
            "googleId": null,
            "email": "[email protected]",
            "username": "Samuel",
            "displayName": "Korku",
            "passwordToken": null,
            "passwordResetExpires": null,
            "deletionDate": null,
            "createdAt": "2023-02-21T18:16:59.000Z",
            "updatedAt": "2023-02-21T19:56:34.013Z"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo2LCJpYXQiOjE2NzcwMDkzOTQsImV4cCI6MTY4NDc4NTM5NH0.swSoyJslxSvXj_rJjcyOZ72TVXXw3rW5dv6Q1cVdM6g"
    }
}

Post

field data_type constraints
body string required
media-url array of image Path

Post Routes


publish a post (logged in users only )

  • Route: /api/v1/post/

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    body sugar no dey salt no dey , he just sweet #hello #welcome
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (4).png
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (3).png
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (1).png
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (7).png
  • Responses

Success

{
  "status": true,
  "post": {
    "likes": 0,
    "status": "Published",
    "commentsNo": 0,
    "views": 0,
    "id": 10,
    "body": "sugar no dey salt no dey , he just sweet #hello #welcome",
    "userId": 1,
    "media_url": [
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910351/pictures/gonsipofzx98ncqvyikf.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910354/pictures/byri1sh4pojttxutd1ts.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910359/pictures/kfiyqmeypabuespxu8a9.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910365/pictures/k39h7ec19wy6iuumlpon.png"
    ],
    "tags": "#hello #welcome",
    "updatedAt": "2023-02-20T16:26:07.155Z",
    "createdAt": "2023-02-20T16:26:07.155Z"
  }
}

Draft a post (logged in users only )

  • Route: /api/v1/post/draft

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    body sugar no dey salt no dey , he just sweet #hello #welcome
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (4).png
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (3).png
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (1).png
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (7).png
  • Responses

Success

{
  "status": true,
  "post": {
    "likes": 0,
    "status": "Draft",
    "commentsNo": 0,
    "views": 0,
    "id": 10,
    "body": "sugar no dey salt no dey , he just sweet #hello #welcome",
    "userId": 1,
    "media_url": [
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910351/pictures/gonsipofzx98ncqvyikf.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910354/pictures/byri1sh4pojttxutd1ts.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910359/pictures/kfiyqmeypabuespxu8a9.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1676910365/pictures/k39h7ec19wy6iuumlpon.png"
    ],
    "tags": "#hello #welcome",
    "updatedAt": "2023-02-20T16:26:07.155Z",
    "createdAt": "2023-02-20T16:26:07.155Z"
  }
}

Edit post (logged in users only )

  • Route: /api/v1/post/:postId

  • Method: patch

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    body tiktok looks like money ritual to grow frollowers #followers
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (15).png
  • Responses

Success

{
  "status": true,
  "updatedPost": {
    "id": 1,
    "body": "changee #change",
    "media_url": [],
    "likesNo": 0,
    "status": "Published",
    "commentsNo": 5,
    "views": 1,
    "tags": "#change",
    "createdAt": "2023-02-24T16:43:05.000Z",
    "updatedAt": "2023-02-24T17:46:45.074Z",
    "userId": 1,
    "user": {
      "id": 1,
      "githubId": null,
      "googleId": null,
      "email": "[email protected]",
      "username": "jojo",
      "displayName": "chukwu",
      "passwordToken": null,
      "passwordResetExpires": null,
      "createdAt": "2023-02-24T16:36:57.000Z",
      "updatedAt": "2023-02-24T16:36:57.000Z",
      "profile": null
    },
    "likes": [],
    "comments": []
  }
}

Delete a post (logged in users only )

  • Route: /api/v1/post/:postId
  • Method: delete
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Post deleted  successful"
}



Get all Post (logged in users only )

  • Route: /api/v1/post
  • Method: GET
  • Header:
    • Cookies: jwt {token}
  • Query params:
    • status (default: Published )
    • userId
    • orderBy (default: updatedAt)
    • tags
    • search (search body)
    • limit (default: 10)
  • Responses

Success

{
 status: true,
 blog:[]
}

Get post by id (logged in users only )

  • Route: /api/v1/post/:postId
  • Method: GET
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
  "status": true,
  "post": {
    "id": 1,
    "body": "i dont know what to do #runtown #jojo",
    "media_url": [
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1677115316/pictures/lipx54ekktwaqozttnkp.png",
      "https://res.cloudinary.com/dhq33r9pa/image/upload/v1677115317/pictures/wv0avows2pykwuimugtv.png"
    ],
    "likesNo": 2,
    "status": "Published",
    "commentsNo": 0,
    "shares": 0,
    "views": 2,
    "tags": "#runtown #jojo",
    "createdAt": "2023-02-23T01:21:57.000Z",
    "updatedAt": "2023-02-23T17:34:12.647Z",
    "userId": 1,
    "user": {
      "id": 1,
      "githubId": null,
      "googleId": null,
      "email": "[email protected]",
      "username": "prere",
      "displayName": "chukwu",
      "passwordToken": null,
      "passwordResetExpires": null,
      "createdAt": "2023-02-23T01:20:59.000Z",
      "updatedAt": "2023-02-23T01:20:59.000Z",
      "profile": null
    },
    "likes": [
      {
        "id": 1,
        "createdAt": "2023-02-23T01:22:20.000Z",
        "updatedAt": "2023-02-23T01:22:20.000Z",
        "userId": 1,
        "postId": 1,
        "commentId": null,
        "commentCommentId": null
      },
      {
        "id": 2,
        "createdAt": "2023-02-23T01:24:47.000Z",
        "updatedAt": "2023-02-23T01:24:47.000Z",
        "userId": 2,
        "postId": 1,
        "commentId": null,
        "commentCommentId": null
      }
    ]
  }
}

like a post (logged in users only )

  • Route: /api/v1/post/like/:postId
  • Method: post
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Post Liked"
} 



disLike a post (logged in users only )

  • Route: /api/v1/post/like/:postId
  • Method: delete
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Post disLiked"
} 



get My Drafts posts (logged in users only )

  • Route: /api/v1/post/myDrafts
  • Method: get
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
 status: true,
 blog:[]
}



Comment Routes


comment

field data_type constraints
body string required
media-url array of image Path

Comment on a Post (logged in users only )

  • Route: /api/v1/comment/new/:postId

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    body yes oo :)
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (4).png
  • Responses

Success

{
  "status": true,
  "comment": {
    "likesNo": 0,
    "commentsNo": 0,
    "views": 0,
    "id": 3,
    "body": "yes oo :)",
    "userId": 1,
    "media_url": [],
    "tags": "",
    "postId": "1",
    "updatedAt": "2023-02-24T16:53:32.792Z",
    "createdAt": "2023-02-24T16:53:32.792Z"
  }
}

get All Comments Of A Post (logged in users only )

  • Route: /api/v1/comment/new/:postId

  • Method: GET

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "status": true,
  "allComments": []
}

delete Comment (logged in users only )

  • Route: /api/v1/comment/:commentId

  • Method: DELETE

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Comment deleted  successful"
}

Get Comment By Id (logged in users only )

  • Route: /api/v1/comment/:commentId

  • Method: GET

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "status": true,
  "comment": {
    "id": 4,
    "body": "yes oooo",
    "media_url": "[]",
    "likesNo": 0,
    "commentsNo": 0,
    "views": 1,
    "tags": "",
    "createdAt": "2023-02-24T16:56:01.000Z",
    "updatedAt": "2023-02-24T21:00:43.645Z",
    "userId": 1,
    "postId": 1,
    "user": {
      "id": 1,
      "githubId": null,
      "googleId": null,
      "email": "[email protected]",
      "username": "jojo",
      "displayName": "chukwu",
      "passwordToken": null,
      "passwordResetExpires": null,
      "createdAt": "2023-02-24T16:36:57.000Z",
      "updatedAt": "2023-02-24T16:36:57.000Z",
      "profile": null
    },
    "likes": []
  }
}

like a comment (logged in users only )

  • Route: /api/v1/comment/like/:commentId
  • Method: post
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Comment Liked"
} 



disLike a comment (logged in users only )

  • Route: /api/v1/comment/like/:commentId
  • Method: delete
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{ 
  "message": "Comment disLiked"
} 


get All Comments Of A Comment (logged in users only )

  • Route: /api/v1/comment/newCom/:commentId

  • Method: GET

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "status": true,
  "allComments": []
}

Comment on a Comment (logged in users only )

  • Route: /api/v1/comment/newCom/:commentId

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    body yes oo :)
    media_url /C:/Users/josiah/Pictures/Screenshots/Screenshot (4).png
  • Responses

Success

{
  "status": true,
  "comment": {
    "likesNo": 0,
    "commentsNo": 0,
    "views": 0,
    "id": 3,
    "body": "yes oo :)",
    "userId": 1,
    "media_url": [],
    "tags": "",
    "postId": "1",
    "updatedAt": "2023-02-24T16:53:32.792Z",
    "createdAt": "2023-02-24T16:53:32.792Z"
  }
}

Profile Routes


Profiles

field data_type constraints
bio string
website string
location string
github_link string
twitter_link string
avatarURL string
headerURL string
followers string

Create profile (logged in and owner of account )

  • Route: /api/v1/profiles/

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    bio too little space for an about
    website string
    location Accra, Ghana
    github_link https://github.com/me
    twitter_link https://twitter.com/me
    avatar(file) avatar-img.jpg
    header(file) header-img.png
  • Responses

Success

{
  "message": "profile create successful",
  "status": true,
  "data": {
    "profile": {
      "id": 1,
      "Bio": "this is my bio",
      "website": "https://mywebsite.com",
      "github_link": "https://github.com/link",
      "twitter_link": "https://twitter.com/me",
      "avatarURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1676993236/tcfh3zmsp6rjha0xe9fm.jpg",
      "headerURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1676993238/on11c5ctymn6noyslddi.png",
      "userId": 2,
      "updatedAt": "2023-02-21T15:25:48.262Z",
      "createdAt": "2023-02-21T15:25:48.262Z"
    }
  }
}

Edit profile (logged in and owner of account )

  • Route: /api/v1/profiles/:profilesId

  • Method: PATCH

  • Header

    • Cookies: jwt {token}
  • Body: Form data

    KEY VALUE
    bio this is my bio
    website www.mywebsite.me
    location Accra, Ghana
    github_link www.github.com/me
    twitter_link www.twitter.com/me
    header(file) header-img.png
  • Responses

Success

{
  "message": "profile updated",
  "status": true,
  "data": {
    "update": {
      "id": 1,
      "Bio": "this is my bio",
      "website": "https://mywebsite.com",
      "location": null,
      "github_link": "https://github.com/link",
      "twitter_link": "https://twitter.com/me",
      "headerURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1676994044/t2vbx9whrkkkkxmwt0hh.png",
      "avatarURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1676993236/tcfh3zmsp6rjha0xe9fm.jpg",
      "followers": null,
      "createdAt": "2023-02-21T15:25:48.000Z",
      "updatedAt": "2023-02-21T15:39:14.441Z",
      "userId": 2
    }
  }
}

Get profile of user

  • Route: /api/v1/profiles/:username

  • Method: GET

  • Responses

Success

{
  "status": "success",
  "message": "Profile found",
  "data": {
    "profile": {
      "username": "jonaa",
      "displayName": "jonaa",
      "Bio": "this is my bio",
      "website": "https://mywebsite.com",
      "location": null,
      "github_link": "https://github.com/link",
      "twitter_link": "https://twitter.com/me",
      "avatarURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1676993236/tcfh3zmsp6rjha0xe9fm.jpg",
      "headerURL": "http://res.cloudinary.com/di4y0ladi/image/upload/v1676994044/t2vbx9whrkkkkxmwt0hh.png",
      "followers": null
    }
  }
}

Followers

field data_type constraints
followeeId number
userId number

Follow Routes


Follow another user

  • Route: /api/v1/follow/username

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "status": "success",
  "message": "User followed"
}

Unfollow user

  • Route: /api/v1/unfollow/username

  • Method: DELETE

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "status": "success",
  "message": "Unfollowed user"
}

Getfollowers route

  • Route: /api/v1/followers

  • Method: GET

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
    "status": true,
    "myFollowers": [],
    "nHit": 0
}

Getfolloweing route

  • Route: /api/v1/following

  • Method: GET

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
    "status": true,
    "myFollowers": [],
    "nHit": 0
}

Block accounts

field data_type constraints
blockedUser number
userId number

Block Routes


Block user

  • Route: /api/v1/user/block/username

  • Method: POST

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "status": "success",
  "message": "User blocked"
}

Unblock user

  • Route: /api/v1/user/unblock/username
  • Method: DELETE
  • Header
    • Cookies: jwt {token}
  • Responses

Success

{
  "status": "success",
  "message": "User unblocked"
}

Privating account Routes


Make account private

  • Route: /api/v1/account/private

  • Method: PATCH

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Account Private Successful"
}

Make account public

  • Route: /api/v1/account/public

  • Method: PATCH

  • Header

    • Cookies: jwt {token}
  • Responses

Success

{
  "message": "Account Public Successful"
}

Contributors

  • Okoronkwo Kelechi Anslem
  • Ademeso Josiah
  • Justice Etorko-Gbeku
  • Sunday Samuel Olubode

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 60.3%
  • EJS 39.7%