Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 4.3 KB

README.md

File metadata and controls

80 lines (49 loc) · 4.3 KB
Raw

License:MIT

Neat Social Network API

Description

This is a social network backend that utilizes MongoDB, Mongoose ODM and Express.js to CRUD and define relationships between collections stored in the mongodb and then served by a Express.js server.

Table of Contents

Demo

Full Demo Video:

  • Full Demo Video: Vimeo URL
  • Full Demo Video: Google Drive

    • Screenshot

    Insomnia Screenshot

    Installation

    To install this app, simply fork the repo, and clone down to your local machine. Then in the CLI at relative dir run 'npm i' to get all dependancies required for sucessfull run of the package. Download MongoDB and MongoDB-Compass. Finally run 'npm run seed' to create database and collection full of seed data.

    Usage (Instructions/How-To Use)

    To use the package run 'npm start' which will sync the db and start the server. First ensure that you have ran an npm i to intall all necessary packages.

    Technologies

    JavaScript, HTML, CSS, Node.js, Express.js, MongoDB, Mongoose

    License

    This project is licensed under the MIT license. For more information about this license and what it entails, visit the MIT website here

    Preview:

    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.

    Tests

    Endpoints were tested with Insomnia. If you should find any issues, see above on contibuting guidlines or submit a issue with a detailed explanation on how to recreate the bug.

    Credits

  • Christina Hall: Full-Stack Developer
  • Terry Lequernaque: Full-Stack Developer
  • Michael Lito: Full-Stack Developer

    • How to Contribute

    Fork the repo and clone down to your local machine. Once you have the latest version of the repo, you can add or make changes then submit a pull request for your changes. Please use best practices as well as proper naming conventions and comments depicting what the code segements function is. Finally in the body of your pull request, please explain why these changes you were necissary and if it is a bug what steps can be completed to reproduce this bug. If these guidelines are not met, pull requests will not be reviewed or accepted.

    Contact / Questions

    If you liked this project and want to see more, feel free to check out my other repos here.
    For any questions or inquiries, you can reach me at blair10324@gmail.com for further information.

  • Blair Millet: Full-Stack Developer

    • © 2023 Neat Social Network API, Inc. All Rights Reserved.