Giter VIP home page Giter VIP logo

social-network's Introduction

Social Network πŸ’¬

Table of Contents

Description πŸ”

  • An application that used mongoose and mongoDB backend for an Social-Network site.

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

Video Link 🎞️

Video Link

Installation πŸ’Ύ

  • Clone the repo and use command npm install to install all require packages.
  • Require Insomnia to test the API ability.

Technologies πŸ”§

Usage πŸ’»

  1. Input command npm start to start up the server. It will also created a database in mongoDB under the name socialDB.

  1. When API GET routes for users and thoughts are opened in Insomnia, the data for each of the routes is displayed in formatted JSON.

  2. User, Friend, Thought, and Reaction routes are created to create the database and test the API on Insomnia.

  3. User Routes

  • To use Get, get by ID, create User, update User, and Delete User, please follow the instruction from the Demo.

  1. Friend Routes - a user can add a friend and delete a friend.
  • To use add a friend or remove a friend, please follow the instruction from the Demo.
  1. Thought Routes - a user can create a thought, get all thoughts or a single thought by ID, update a thought by ID, and delete a thought by ID.
  • To use create, get, get by ID, update, and delete a thought, please follow the instruction from the Demo.
  1. Reaction Routes - a user can create a reaction and delete a reaction.
  • To use create or delete a reaction, please follow the instruction from the Demo.

Gif Demo 🎞️

Demo

License ©️

✏️ This project is license under MIT

Contributing 🧩

Please refer to "Fork" or be assigned by Owner.

Questions ❓

If you have any questions about this project, please contact me directly at [email protected]. You can view more of my projects at https://github.com/NguyenDoan85.

Author 🎊

  • This app created by me, please follow my Github for more cool app.
  • Here is my Linkedin!

social-network's People

Contributors

nguyendoan85 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.