kzefram / SocialNetworkAPI

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SocialNetworkAPI

Contents

Description

A social network API using NoSQL and Mongoose. The following is the bases for this project:

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

Accptance 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

Dependencies

  • "dotenv": "^16.4.5",
  • "express": "^4.19.1",
  • "mongoose": "^8.2.2",
  • "sequelize": "^6.37.1",
  • "if-env": "^1.0.4"

Dev Dependencies

  • "nodemon": "^3.1.0",
  • "open": "^10.1.0",
  • "concurrently": "^8.2.2"

Installation

There is some installation required:

  • First you need to download Node,
  • Then do npm install,
  • npm i express,
  • npm i sequelize,
  • npm i nodemon,
  • npm i mongoose,
  • npm i dotenv,
  • npm i if-env,
  • npm i --save-dev nodemon concurrently
  • If you don't have Insomnia or Postman installed, you may want to do that as well

Usage

I will be using Insomnia to show the application is functioning properly. A social network API using NoSQL and Mongoose

Credits

  • Karen Bourgeois,
  • EDx

License

MIT

Badges

Features

Contributions

Tests

About

License:MIT License


Languages

Language:JavaScript 100.0%