Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zbichsel/mongo-network-api
This API facilitates seamless user interactions by allowing real-time updates and efficient data management through MongoDB. It also supports features like user authentication, ensuring secure access and personalized experiences for each user.
https://github.com/zbichsel/mongo-network-api
express mongoose
Last synced: 4 days ago
JSON representation
This API facilitates seamless user interactions by allowing real-time updates and efficient data management through MongoDB. It also supports features like user authentication, ensuring secure access and personalized experiences for each user.
- Host: GitHub
- URL: https://github.com/zbichsel/mongo-network-api
- Owner: zbichsel
- License: mit
- Created: 2023-08-23T20:18:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-26T19:39:51.000Z (over 1 year ago)
- Last Synced: 2024-11-19T15:58:16.859Z (2 months ago)
- Topics: express, mongoose
- Language: JavaScript
- Homepage:
- Size: 3.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mongo-network-api
An API for a social network web application where users can share their thoughts, react to friends’ thoughts, and create a friend list.
[](https://shields.io/docs/logos)
[](https://shields.io/docs/logos)
[](https://shields.io/docs/logos)
[](https://shields.io/docs/logos)
## Description
An innovative social media backend app powered by MongoDB, designed for seamless user interactions. It efforlessly manages user profiles, posts, comments, friends, and reactions while ensuring flexibility. The app leverages MongoDB's NoSQL capabilities to store and retrieve data rapidly, providing a responsive and dynamic social experience.
In its current state, there is no frontend for the app, so the user would need to use Insomnia to test the routes and access their database.
## Table of Contents
- [Screen Recording](#screen-recording)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [Questions](#questions)
## Installation
Git clone the repository.
Please make sure that the **dependencies** have been installed. If not, please run the following commands:
`npm i express`\
`npm i mongoose`\
`npm i dotenv`
This will install the necessary packages and versions which are necessary for the application to run. Learn more about [Mongoose](https://www.npmjs.com/package/mongoose), [Dotenv](https://www.npmjs.com/package/dotenv), and [Express](https://www.npmjs.com/package/express) in the links provided.
The user will need to create an account at [MongoDB](https://www.mongodb.com/) and download the interface as well as download [Insomnia](https://insomnia.rest/) in order to utilize the app.
## Usage
To access this social media API application, please run the following command in your integrated terminal for this repository:
`node index.js`
## Screen Recording
https://github.com/zbichsel/mongo-network-api/assets/136612956/6d92d951-ceb1-4f0e-9abd-1092b30249dd
## Screenshot
## License
[](https://opensource.org/licenses/MIT)
This project is licensed under MIT. Please check LICENSE document in repository for more information.
## How to Contribute
If you would like to contribute to this project, please open a new issue or submit a pull request.
## Tests
Testing of this application requires the installation and use of Insomnia at this time.
## Questions
If you have any questions, feel free to reach me at [GitHub](https://github.com/zbichsel) or via email at [[email protected]]([email protected]).