Skip to content

Bfunk54/MongoDB-SocialMediaAPI

Repository files navigation

MIT License

MongoDB-SocialMediaAPI

Description

This is an api utilizing technologies from Mongoose and MongoDB to create a database to store users, posts, and comments to those posts along with friends, friend counts and comment/reaction counts. This would be the backend for a social media network, it allows you to use all CRUD operations on both users and posts with many more functions making it ready for implementation.

Table of Contents

  1. Installation

  1. Usage

  1. License

  1. Contribute

  1. Tests

  1. Screenshots

  1. Questions

(back to top)

Installation

To install, clone the repo into your favorite code editor. Run the command 'npm i' to install the needed dependencies to run this server. Now you should be able to run the command 'npm run dev' and this should start the server up.

(back to top)

Usage

To use it, run that 'npm run dev' command and then you can use your favorite API Editor such as Postman or Insomnia to access it at 'localhost:3001'. Now go to the routes folder to see what routes to run. All routes will have /api first and everything should work well. You can use the seeds in the seed folder to get you started.

(back to top)

License

MIT License

(back to top)

Contributing

Bfunk54/MongoDB-SocialMediaAPI

(back to top)

Tests

To test, install it, then use it and test all routes available. All functionality should be self-explanitory with the variable names and commenting.

(back to top)

Screenshots

(back to top)

Questions

Github: https://github.com/Bfunk54

Email me with any questions: ben_fein@icloud.com

(back to top)

Links

Video Walkthrough

Github Repo

(back to top)