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. It uses Express.js for routing, a MongoDB database, the Mongoose ODM, and Moment.js to format timestamps. The seed data is created using Insomnia.

To see how the API works using Insomnia, see the walk-through demonstration videos here: https://drive.google.com/file/d/1MQ2WUP7RbTJPUuadVkVzzmjbWWJe8IWU/view

Table of Contents 📖

• Application Preview ⭐
• Features 📋
• Installation 🗳
• Usage 💡
• Technologies 🔧
• Tests
• Contribution 👩🏻‍💻
• Questions ❓
• Credits 🙌

Application Preview ⭐

Demo Gif

All GET POST PUT DELETE route for Users, Thoughts, Friends, Reactions.

See functionalities in Features section.

Features 📋

1. This is a social network API that uses MongoDB, a NoSQL database, which allows the website to handle large amounts of unstructured data.

2. When the command to invoke the application is entered, the Mongoose models are synced to the MongoDB database.

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

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

5. User Routes - a user can create a user with a username and valid email address. When created, the user is assigned a unique user ID.

• To create a user, click the POST request and enter the user's username and email address. Click Send.

• There are two GET requests that return user information. To return all users, click the Find All Users request, then click on Send. To return a single user, click the Find User by Id request. On the URL, enter the user's ID.

• To update a user by ID, click the PUT request. On the URL, enter the ID of the user whose information is going to be updated.

• To delete a user by ID, click the DELETE request and enter the user's ID.

• A message that reads, "User and thoughts deleted!" will appear if the user has been deleted from the database. If there is no such user or user ID in the system, the message, "No user with this id!" is shown.

• Click Find All Users to see if the user has been deleted.

6. Friend Routes - a user can add a friend and delete a friend.

• To add a friend, click the POST request. On the URL enter the user ID of the user who is adding a friend, then the user ID of the friend the user is adding. *(Note: Please see the section on Tests for the API routes.)*

• To see the user's friends, click Find All Users. The ID of the friends the user added are listed under "friends". The "friendCount" indicates the number of friends the user added.

• To remove or delete a friend, click the DELETE request. On the URL enter the user ID of the user who is deleting a friend, then the user ID of the friend the user is deleting.

• To check if the friend has been removed from the user's friend list, click Find All Users.

7. 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 create or add a thought, click the POST request. Enter the "thoughtText", "username", "userID" of the user creating the thought.

• To get all thoughts, click the GET All Thoughts request. All the thoughts that were created will appear, as well as the date and time they were created. Each created thought is assigned a unique thought ID. Click GET All Users to access the thought ID.

• To get a thought by ID, click the GET Thought by Id request and enter the thought ID.

• To update a thought, click the PUT request. On the URL, enter the thought ID. Enter the necessary changes on the text body. To see the changes, click GET All Thoughts.

• To delete a thought by ID, click the DELETE request. On the URL, enter the thought ID that will be deleted.

• When the thought is successfully deleted, the text can no longer be found when you try to access it by clicking GET All Thoughts. The thought ID is also deleted when you click Find All Users.

8. Reaction Routes - a user can create a reaction and delete a reaction.

• To create a reaction, click the POST request. On the URL, enter the ID of the thought the user is reacting or commenting on. Then enter the "reactionBody" and "username" of the user creating the reaction.

• Click on GET All Thoughtsto see the reaction, the username of the user who created the reaction, the reaction ID, date and time the reaction is created, and the user's reaction count.

• To delete a reaction, click the DELETE request. On the URL, enter the ID of the thought the user created a reaction or commented on, then the reaction ID.

• The message, "No thought with this id!" will appear when a reaction is deleted or a reaction is not associated with a user ID.

9. MongoDB - After creating data on Insomnia, MongoDB also reflects the same data and changes that were made:

   

Installation 🗳

• Download or clone repository to use this application on local machine.
• Node.js and MongoDB is required to run the application
• To install necessary dependencies, navigate to the root directory and run the following command: npm i

Usage 💡

For more information - Please visit the following videos on how the application works. https://drive.google.com/file/d/1MQ2WUP7RbTJPUuadVkVzzmjbWWJe8IWU/view

After installation :

• To invoke the application, run npm start.
• When the server is started, the Mongoose models are synched to the MongoDB database.
• Open MongoDB and connect to the MongoDB URI mongodb://localhost:27017. On the list of databases, click on socialDB to see thoughts and users data.
• To create seed data and test the API routes, use Insomnia. Also, see the Tests section below.

Technologies 🔧

• JavaScript
• Express.js
• Node.js
• MongoDB
• Mongoose
• Insomnia
• Moment.js

Tests

Insomnia is used to test REST API calls. Please see the walk-through demonstration videos: https://drive.google.com/file/d/1MQ2WUP7RbTJPUuadVkVzzmjbWWJe8IWU/view as well as the sections on Description and Usage to see how data is added and tested using Insomnia.

On Insomnia, the following API routes have been created and used to add, update, or remove users, friends, thoughts, and reactions in the user's database.

📁 USER

• Create a new user: POST /api/users

• Get all users: GET /api/users

• Get a single user by its id: GET /api/users/:userId

• Update a user by its id: PUT /api/users/:userId

• Delete a user by its id: DELETE /api/user/:userId

📁 FRIEND

• Add a new friend to a user's friend list: POST /api/users/:userid/friends/:friendId
• Delete a friend from a user's friend list: DELETE /api/users/:userid/friends/:friendId

📁 THOUGHT

• Create a new thought: POST /api/thoughts/
• Get all thoughts: GET /api/thoughts/
• Get a single thought by its id: GET /api/thoughts/:thoughtId
• Update a thought by its id: PUT /api/thoughts/:thoughtId
• Delete a thought by its id: DELETE /api/thoughts/:thoughtId

📁 REACTION

• Create a reaction: POST /api/thoughts/:thoughtId/reactions
• Delete a reaction by the reactionId: DEL /api/thoughts/:thoughtId/reactions/:reactionId

License 📜

MIT License

Copyright (c) 2022 Sienna Li

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contribution 👩🏻‍💻

If you would like to contribute to this project reach out to me. Contact Information can be found below or by clicking on the Questions link provided in the Table of Contents.

Questions ❓

📩 If you have any question, email me here at : lihexuan1@gmail.com
My Github page is siennameow

Credits 🙌

Thanks to the following people who helped me in this project:

• Jerome Chenette
• Manuel Nunes
• Vince Lee