A Backend API for a Social Media Platform (LinkUp)

LinkUp is a backend API for a social media platform built by Chinwendu Enyinna using a couple JavaScript-based server side technologies. This API follows the REST architectural design pattern.

Explore the docs »

View Demo

Technologies used

Requirements

The following are the requirements I implemented in this project 👇:

Development

Prerequisites

Clone this repo

 git clone https://github.com/wendeee/socialmediaAPI.git

Install project dependencies

npm install

Update .env with example.env

Sign up on Cloudinary to get API_KEY for free and other details needed in your .env file
To implement forgot password and reset password functionality, I used Nodemailer and mail trap to send reset token to user's email.
Sign up on mailtrap for free to get the following details👇:
- EMAIL_USERNAME
- EMAIL_PASSWORD
- EMAIL_HOST
- EMAIL_PORT

Run development server

npm run start:dev

Models

User

field	data_type	constraints
firstname	string	required
lastname	string	required
username	string	required
email	string	required
password	string	required
passwordConfirm	string	required
followers	objectId	referenced
followings	objectId	referenced
posts	objectId	referenced
joinedOn	Date	added dynamically

Post

field	data_type	constraints
post	string	required
author	objectId	referenced
state	string	required, enum: ['draft', 'shared']
image	string	optional
likes	Number	added dynamically
numOfRepost	Number	added dynamically
comments	objectId	referenced
timestamps	Date	required

RePost

field	data_type	constraints
_user	objectId	referenced
_post	objectId	referenced
timestamps	Date	required

likePost

field	data_type	constraints
_user	objectId	referenced
_post	objectId	referenced
timestamps	Date	required

Comment

field	data_type	constraints
_user	objectId	referenced
_post	objectId	referenced
comment	string	required
likes	Number	dynamically added
timestamps	Date	required

likeComment

field	data_type	constraints
_user	objectId	referenced
_comment	objectId	referenced
timestamps	Date	required

API Endpoints

Base URL

https://linkup.cyclic.app

USERS

Register/Sign up a user

Route: /api/auth/signup
method: POST
👇: Body

{
   "firstname":"Jackson",
    "lastname":"Ben",
    "username":"jacksonben",
    "email": "[email protected]",
    "password": "jackson12345",
    "passwordConfirm": "jackson12345"
}

👇: Response

{
    "status": "success",
    "token": {token},
    "data": {
        "user": {
            "firstname": "Jackson",
            "lastname": "Ben",
            "username": "jacksonben",
            "email": "[email protected]",
            "followers": [],
            "followings": [],
            "joinedOn": "2022-12-09T22:05:06.564Z",
            "posts": [],
            "_id": "6393b13a97e46808bb9c9a3e",
            "createdAt": "2022-12-09T22:05:46.826Z",
            "updatedAt": "2022-12-09T22:05:46.826Z",
            "__v": 0
        }
    }
}

Login/Sign in a user

Route: /api/auth/login method: POST

👇: Body

{
    "email": "[email protected]",
    "password": "jackson12345"
}

👇: Response

{
    "status": "success",
    "token": {token}
}

Forgot Password

Route: /api/auth/forgotPassword
Method: POST

👇: Body

{
    "email": "[email protected]"
}

👇: Response

{
    "status": "success",
    "message": "A reset token has been sent to your email"
}

Reset Password

Route: /api/auth/resetPassword/:token
Method: PATCH

👇: Body

{
    "password": "jacksonnewpassword",
    "passwordConfirm": "jacksonnewpassword"
}

👇: Response

{
    "status": "success",
    "token": {token}
}

Follow a user

Route: /api/v1/users/:toFollowId/follow
Method: PATCH
Header
- Authorization: Bearer {token}

👇 :Response

{
    "status": "success",
    "response": "following johndoe!"
}

unfollow a user

Route: /api/v1/users/:toUnfollowId/unfollow
Method: PATCH
Header
- Authorization: Bearer {token}

👇 :Response

{
    "status": "success",
    "message": "johndoe unfollowed successfully!"
}

Get Followings

Route: /api/v1/users/followings
Method: GET
Header
- Authorization: Bearer {token}

👇 :Response

{
    "numOfFollowings": 1,
    "followings": [
        {
            "firstname": "John",
            "lastname": "Doe"
        }
    ]
}

POSTS

Create a Post

Route: /api/v1/posts
Method: POST
Header
Authorization: Bearer {token}

👇: Body

{
    "post": "lorem iiiggg hhhaaa hhdddsn jkljskvhl vzbvzklvjhzv vn zhbvlVz n"
}

👇: Response

{
    "success": true,
    "data": {
        "author": "6393b13a97e46808bb9c9a3e",
        "post": "lorem iiiggg hhhaaa hhdddsn jkljskvhl vzbvzklvjhzv vn zhbvlVz n",
        "state": "draft",
        "image": "",
        "likes": 0,
        "numOfReposts": 0,
        "comments": [],
        "_id": "6393b41597e46808bb9c9a42",
        "createdAt": "2022-12-09T22:17:57.764Z",
        "updatedAt": "2022-12-09T22:17:57.764Z",
        "__v": 0
    }
}

//A post with an uploaded image
{
    "success": true,
    "data": {
        "author": "63910022e9cd10c8589fdda9",
        "post": "A post with an image",
        "state": "draft",
        "image": "https://res.cloudinary.com/dwsbmjhzd/image/upload/v1670604617/wgqddvyzvbd73nnuovvc.jpg",
        "likes": 0,
        "numOfReposts": 0,
        "comments": [],
        "_id": "6393e519d3208257faba9a44",
        "createdAt": "2022-12-10T01:47:06.016Z",
        "updatedAt": "2022-12-10T01:47:06.016Z",
        "__v": 0
    }
}

Update a Post

Route: /api/v1/posts/:postId
Method: PUT
Header
Authorization: Bearer {token}

👇: Body

{
   "state": "shared"
}

👇: Response

{
    "status": "success",
    "data": {
        "_id": "6393b41597e46808bb9c9a42",
        "author": "6393b13a97e46808bb9c9a3e",
        "post": "lorem iiiggg hhhaaa hhdddsn jkljskvhl vzbvzklvjhzv vn zhbvlVz n",
        "state": "shared",
        "image": "",
        "likes": 0,
        "numOfReposts": 0,
        "comments": [],
        "createdAt": "2022-12-09T22:17:57.764Z",
        "updatedAt": "2022-12-09T22:30:17.243Z",
        "__v": 0
    }
}

Edit a Post

Route: /api/v1/posts/:postId
Method: PATCH
Header
Authorization: Bearer {token}

👇: Body

{
    "post": "Lorem ipsum updated"
}

👇: Response

{
    "status": "success",
    "data": {
        "_id": "6393c921fe99aa758d819ac1",
        "author": "6393c1bcfe99aa758d819aa4",
        "post": "Lorem ipsum updated",
        "state": "shared",
        "image": "",
        "likes": 0,
        "numOfReposts": 0,
        "comments": [],
        "createdAt": "2022-12-09T23:47:45.581Z",
        "updatedAt": "2022-12-09T23:50:08.612Z",
        "__v": 0
    }
}

Like a Post

Route: /api/v1/posts/:postId/like
Method: PATCH
Header
Authorization: Bearer {token}

👇: Response

{
    "status": "success",
    "message": "You liked this post",
    "post": {
        "_id": "6393b41597e46808bb9c9a42",
        "author": "6393b13a97e46808bb9c9a3e",
        "post": "lorem iiiggg hhhaaa hhdddsn jkljskvhl vzbvzklvjhzv vn zhbvlVz n",
        "state": "shared",
        "image": "",
        "likes": 1,
        "numOfReposts": 0,
        "comments": [],
        "createdAt": "2022-12-09T22:17:57.764Z",
        "updatedAt": "2022-12-09T22:30:17.243Z",
        "__v": 0
    }
}

Unlike a Post

Route: /api/v1/posts/:postId/like
Method: PATCH
Header
Authorization: Bearer {token}

👇: Response

{
    "message": "You unliked this post",
    "postToLike": {
        "_id": "6393b41597e46808bb9c9a42",
        "author": "6393b13a97e46808bb9c9a3e",
        "post": "lorem iiiggg hhhaaa hhdddsn jkljskvhl vzbvzklvjhzv vn zhbvlVz n",
        "state": "shared",
        "image": "",
        "likes": 0,
        "numOfReposts": 1,
        "comments": [],
        "createdAt": "2022-12-09T22:17:57.764Z",
        "updatedAt": "2022-12-09T22:39:16.038Z",
        "__v": 0
    }
}

Repost a Post

Route: /api/v1/posts/:postId/repost
Method: POST
Header
Authorization: Bearer {token}

👇: Response

{
    "status": "success",
    "message": "You reposted this post",
    "post": {
        "_id": "6393b41597e46808bb9c9a42",
        "author": "6393b13a97e46808bb9c9a3e",
        "post": "lorem iiiggg hhhaaa hhdddsn jkljskvhl vzbvzklvjhzv vn zhbvlVz n",
        "state": "shared",
        "image": "",
        "likes": 0,
        "numOfReposts": 1,
        "comments": [],
        "createdAt": "2022-12-09T22:17:57.764Z",
        "updatedAt": "2022-12-09T22:39:16.038Z",
        "__v": 0
    }
}

Comment on a Post

Route: /api/v1/posts/:postId/comment
Method: POST
Header
Authorization: Bearer {token}

👇: Body

{
    "comment": "Great write up!"
}

👇: Response

{
    "status": "success",
    "message": "You commented on this post",
    "data": {
        "comment": {
            "_user": "6393b13a97e46808bb9c9a3e",
            "comment": "Great write up!",
            "_post": "6393b41597e46808bb9c9a42",
            "likes": 0,
            "_id": "6393ba5197e46808bb9c9a61",
            "createdAt": "2022-12-09T22:44:33.937Z",
            "updatedAt": "2022-12-09T22:44:33.937Z",
            "__v": 0
        }
    }
}

Like a comment to a Post

Route: /api/v1/posts/:postId/:commentId/like
Method: PATCH
Header
Authorization: Bearer {token}

👇: Response

{
    "status": "success",
    "message": "You liked this comment",
    "data": {
        "comment": {
            "_id": "6393ba5197e46808bb9c9a61",
            "_user": "6393b13a97e46808bb9c9a3e",
            "comment": "Great write up!",
            "_post": "6393b41597e46808bb9c9a42",
            "likes": 1,
            "createdAt": "2022-12-09T22:44:33.937Z",
            "updatedAt": "2022-12-09T22:44:33.937Z",
            "__v": 0
        }
    }
}

Delete a Post

Route: /api/v1/posts/:postId/
Method: DELETE
Header
Authorization: Bearer {token}

👇: Response

{
    "status": "success",
    "message": "post deleted sucessfully"
}

Lessons I learned while working on this:

How to model data
Mongoose Database Schema Design
User authentication authorization with JWT
Database Query
User Authentication
How to craft a presentable README.md
How to upload image using multer and cloudinary
How to implement forgot password and reset password using Nodemailer

Contact

Twitter - @_ChinwenduE
Email - [email protected]

Project Link: https://github.com/wendeee/socialmediaAPI

Name		Name	Last commit message	Last commit date
Latest commit History 71 Commits
src		src
tests		tests
.gitignore		.gitignore
.prettierrc		.prettierrc
README.md		README.md
example.env		example.env
package-lock.json		package-lock.json
package.json		package.json

wendeee/socialmediaAPI

Folders and files

Latest commit

History

Repository files navigation

A Backend API for a Social Media Platform (LinkUp)

Technologies used

Requirements

Development

Prerequisites

Clone this repo

Install project dependencies

Update .env with example.env

Run development server

Models

User

Post

RePost

likePost

Comment

likeComment

API Endpoints

Base URL

USERS

Register/Sign up a user

Login/Sign in a user

Forgot Password

Reset Password

Follow a user

unfollow a user

Get Followings

POSTS

Create a Post

Update a Post

Edit a Post

Like a Post

Unlike a Post

Repost a Post

Comment on a Post

Like a comment to a Post

Delete a Post

Lessons I learned while working on this:

Contact

Acknowledgments

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages