NBS5000 / socialApi

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Social API - Steve Barry

The Task

The task was to build an API for a social network web application where users can share their thoughts, react to friends’ thoughts, and create a friend list

⭐ ⭐ S.T.A.R. ⭐ ⭐

SITUATION

The provided user story was:

AS A social media startup

I WANT an API for my social network that uses a NoSQL database

SO THAT my website can handle large amounts of unstructured data

TASK

Provide an API solution where users can share thoughts, create friend lists, and react to thoughts.

ACTION

Writing of a solution to resolve the situation, including:

  • Javascript
    • Error free performance
    • Multiple functions to separate aspects of code
    • Thorough comments
  • GIT
    • Numerous commits to track changes in code
    • Code added to public repository and Github Pages for public viewing
  • Functionality
    • Multiple functions to allow a user carry out all of their required tasks
    • Error handling, with feedback to users

RESULT

The end code is stored on Github, and publicly available and viewable. This result meets all requirements of the User Story and acceptance criteria:

  • GIVEN a social network API
  • WHEN I enter the command to invoke the application
  • THEN my server is started and the Mongoose models are synced to the MongoDB database
  • WHEN I open API GET routes in Insomnia for users and thoughts
  • THEN the data for each of these routes is displayed in a formatted JSON
  • WHEN I test API POST, PUT, and DELETE routes in Insomnia
  • THEN I am able to successfully create, update, and delete users and thoughts in my database
  • WHEN I test API POST and DELETE routes in Insomnia
  • THEN I am able to successfully create and delete reactions to thoughts and add and remove friends to a user’s friend list

The Outcome

As the acceptance criteria has been met and the task is now complete.

You can view the Github repo HERE

You can view the demo video HERE


Written by Steve Barry - Due date 11/04/2022

© 2021 Trilogy Education Services, LLC, a 2U, Inc. brand. Confidential and Proprietary. All Rights Reserved.

About


Languages

Language:JavaScript 100.0%