/keller-social-network

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

Primary LanguageJavaScript

Social Network API

Description

This is 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

Technology Stack

javaScript expressJS nodeJS mongoDB mongoose momentJS

User Story

  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

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

Installation

  • Ensure you are running Node.js v16.
  • Clone the repository.
  git clone git@github.com:erin-m-keller/keller-social-media.git
  • Install the dependencies.
  cd keller-social-network
  npm i
  • Seed the database
  npm run seed
  • Start the server in the terminal
  npm start

Application available at localhost:3001. Use Insomnia or Postman to use the API

Screenshot

insomniaScreenshot

Usage

Social-Network-API-Demo.mp4

License

MIT license

Questions

If you have any questions about this project, please contact me directly at aestheticartist@gmail.com.
You can view more of my projects here.