This project represents a fully-functioning sample API for a generic social networking platform. The API runs on an Express.js server for routing, MongoDB to establish a NoSQL database, and Mongoose for object data modelling.
To run the application users must first download NodeJS. A step by step guide to download NodeJS onto your machine may be found here.
Additionally, the Insomnia API Client allows full exploration of the application's functionality. A step by step guide to download Insomnia onto your machine may be found here.
Utilizing the Insomnia API Client, users may explore the RESTful routes created by the program and explore the CRUD capabilities afforded. The video linked below represents a tutorial of turning the server on and sending requests to the various API endpoints.
Copyright 2023 Colby Sanchez Wagenbach
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.
You can find me on GitHub @csanchezwagenbach or you can send me an email at csanchezwagenbach@gmail.com