zaferozerr / nates-nosql

Module 18 challenge

Natess' NoSQL API "Telepathy App"

Description.

Nates' NoSQL API "Telepathy App" is a Node.js application programming interface (API) that allows users to perform CRUD operations on social networking data models using a NoSQL database (No MySQL was harmed in the making of this). The data models include users, thoughts, and reaction data models, and they can be retrieved by ID or all of them. This API is built using Node.js and MongooseDB, and it provides a simple and scalable way to handle social networking data without the restrictions of traditional relational databases. Since this app will not be published, refer to my video recording below to show functionality.

Table of Contents:

• Overview
• The Challenge
• Usage Information
• Installation Process
• Built With
• What I Learned
• Continued Development
• License
• Author
• Acknowledgments

Overview

The Challenge:

The challenge was to build a RESTful API that allows a social media startup to perform CRUD operations on users, thoughts, and reactions data models using a NoSQL database. The API must be built using Node.js and Mongoose and must provide endpoints that can handle large amounts of unstructured data.

API must allow users to:

• Create and delete user accounts.
• Create, read, update, and delete thoughts.
• Add and remove reactions to thoughts.
• Add and remove friends to a user's friend list.

Test API: use Insomnia or a similar tool to send HTTP requests to the API endpoints and verify that the responses are correct.

Assigned 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

Usage Instructions:

1. Repository: Open documentation run 'npm i' and update '.env'.
2. Create a .env file in the root directory of the project and add the following variables:
3. Once the server is running, use a tool like Insomnia to test the API endpoints.
4. Use Insomnia to test http://localhost:3001 with the following route end points API GET, POST, PUT, and DELETE routes for categories, products, and tags, ensuring successful creation, updating, and deletion of data in the database.

Available Endpoints:

Each endpoint must include the necessary data in the request body or URL parameters as specified in the acceptance criteria.

1. GET /api/users - get all users
2. GET /api/users/:userId - get a single user by ID
3. POST /api/users - create a new user
4. PUT /api/users/:userId - update a user by ID
5. DELETE /api/users/:userId - delete a user by ID
6. GET /api/thought - get all thought
7. GET /api/thought/:thoughtId - get a single thought by ID
8. POST /api/thought - create a new thought
9. PUT /api/thought/:thoughtId - update a thought by ID
10. DELETE /api/thought/:thoughtId - delete a thought by ID
11. POST /api/thought/:thoughtId/reactions - add a reaction to a thought
12. DELETE /api/thought/:thoughtId/reactions/:reactionId - remove a reaction from a thought
13. POST /api/users/:userId/friends/:friendId - add a friend to a user's friend list
14. DELETE /api/users/:userId/friends/:friendId - remove a friend from a user's friend list

GitHub Repository:

GitHub Repository:

YouTube Walkthrough Video:

Figure 1. Installation and Seeding with MongoDB

YouTube Link #1

Figure 2. Showing Insomnia CRUD API actions

YouTube Link #2

Screenshots:

Figure 1. Screenshot.

Figure 2. Screenshot.

Installation Process:

1. Clone the Repository from GitHub (or) Download Zip Folder from Repository from GitHub.
2. Open the cloned (or downloaded) repository in any source code editor.
3. Open the integrated terminal of the document and complete the respective installation guides provided in "Built With" to ensure the cloned documentation will operate.

Built With:

• JSON: JSON
• Dynamic JavaScript
• Mongoose: 7.0.3
• Express: 4.18.2
• Node.js: 16.18.1
• Insomnia: by Kong
• MongoDB: Website
• Nodemon: 2.0.12
• License Badge: Shields.io
• Visual Studio Code: Website

What I Learned:

1. Built a RESTful API with Node.js and Mongoose.
2. Used NoSQL database to handle unstructured data.
3. Created endpoints for CRUD operations on users, thoughts, and reactions data models.
4. Implemented endpoints to add and remove friends from a user's friend list.
5. Tested API endpoints using Insomnia.
6. Worked with HTTP requests and JSON formatted data.
7. Utilized environment variables and .env files for sensitive data.

Continued Development:

1. Implement additional features to enhance the user experience.
2. Improve error handling and response messaging for better user feedback.
3. Optimize database performance to handle large amounts of data efficiently.
4. Explore different types of NoSQL databases and evaluate their suitability for the project requirements.
5. Expand API documentation to assist developers with using the API.

License & Copyright ©

Open Source Initiative Link

Copyright © 2023 Nathan Weekley

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.

Author

Follow me on Github at Nathan Weekley! Additional questions or concerns? feel free to contact me at [email protected].

© 2023 Nathan Weekley. Confidential and Proprietary. All Rights Reserved.