Skip to content

DrDano/inter-App

Repository files navigation

inter-App

Interactive social networking API designed for any frontend platform. Ready, set, inter-App!

Description

Walk through video preview Walk through video link

This application is not deployed, but is a social-networking API designed to be integrated with any application desiring this functionality.

inter-App lends itself to any application looking to incorporate users, comments, and friends into their app. This is a simple-to-use design with a lot of power behind the curtain.

inter-App is built on a MongoDB database and operates on the Mongoose ODM to give the data structure and reliability. Express is responsible for all of the routing and will integrate seamlessly with your front end.

The app incorporates users, comments (Thoughts), reactions, and friends. Thoughts are dependent on Users, so removing a user removes all of their thoughts. Friends are simply relations of users to one another, and reactions are actually stored in Thoughts, so deleting a thought will delete all of its reactions by default.

Table of contents

Installation

It is important that you have both node.js and MongoDB installed before attempting to install the rest of the application's dependencies and running it.

Then begin by running npm install in your terminal and finally npm start. You can import the included Insomnia-routes-interApp.json file into Insomnia if you are using that to test the routes. That file includes every possible route currently included with inter-App.

Usage

Once the app is running, it is just a matter of testing each route. Keep in mind that there will only ever be one id required in the url of the route. Any other required ids will be required in the body of the request.

There are useful error messages with each route that will tell you what to do next if the route is not working.

Maintainer

@Daniel Harned

Email: [email protected]

Contributing

Fork the project if you would like to contribute, and build into any front end!

Credits

License

Licensed under MIT 2022

About

Interactive social networking API designed for any frontend platform. Ready, set, inter-App!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published