MtendeRoll / social-networkAPI

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Social Network Api

This an API for a social network web application where users can share their thoughts, react to friends’ thoughts, and create a friend list.

Table of contents

Installation

The JSON file will have the necessary dependencies. Type this in your command line:

npm i

Start the application :

npm start

Open Insomnia test out routes

Application 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

Links

Tools Used

Application Gif

  • Mock-Up

Walkthrough Video

  • Part 1 Part 1 shows the GET request for all users, users by Id, all thoughts, thoughts by Id and how to create a user
  • Part 2 Part 2 shows the POST request for thoughts, reactions and friends aswell as a PUT request for users
  • Part 3 Part 3 shows the DELETE request for thoughts by Id, reactions, friends and users

License

MIT License Copyright (c) [2022] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

License:MIT License


Languages

Language:JavaScript 100.0%