shanshantina / social-network-api

social-network-API

Description

Social Network API is an API for a social network web application where users can share their thoughts, react to friends’ thoughts, and create a friend list. This API is built by Express.js, MongoDB database, and Mongoose package.

The details for how this API work is in Tests section.

Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Credits
• Questions

Installation

Instructions to get the application run:

1. Download and install Visual Studio Code if user don't have it installed in the computer.
2. Download and install Node.js if user don't have it installed in the computer.
3. Open the terminal, first run npm install express mongoose moment to install all the packages:
   • express is for the API routes.
   • mongoose is Object Data Manager.
   • moment is for format the timestamps.

The application server itself runs by command npm start.

Usage

Social Network API gives a social network API:

1. when user enters the command to invoke the application, then the server is started and the Mongoose models are synced to the MongoDB database.
2. when user opens API GET routes in Insomnia Core for users and thoughts, then the data for each of these routes is displayed in a formatted JSON.
3. when user tests API POST, PUT, and DELETE routes in Insomnia Core, then user is able to successfully create, update, and delete users and thoughts in the database.
4. when user tests API POST and DELETE routes in Insomnia Core, then user is able to successfully create and delete reactions to thoughts and add and remove friends to a user’s friend list.

The demoes for API testing are in Tests section

License

This project is under license MIT

License Link

Contributing

Not Available

Tests

The application's API routes being tested in Insomnia Core.

Start Server, Find All Users and Thoughts

Find Single User and Thought By ID

User Create, Update, and Delete

Thought Create, Update, and Delete

Friend Create and Delete

Reaction Create and Delete

Credits

The lists of resources used to complete this challenge:

1. Module 18 NoSQL from canvas.
2. Google (https://www.google.ca/)
3. MDN Web Docs (https://developer.mozilla.org/en-US/docs/Web/JavaScript).
4. mongoDB (https://docs.mongodb.com/manual/mongo/).
5. mongoose (https://mongoosejs.com/).
6. mongoose validation (https://mongoosejs.com/docs/validation.html).
7. moment npm (https://www.npmjs.com/package/moment).
8. Supports from instructor, assistant instructor and Tutor.

Questions

For any questions, please contact me with the information below:

GitHub: @shanshantina

Email: [email protected]