Social Network API

🌟Description

Using this API, you can create a social network that feeds data from MongoDB to a database, routes data using Express.js, processes time stamps using Mongoose ODM, and uses the moment package.

Table-of-Contents

• Description
• Submission
• User Story
• Acceptance Criteria
• Walkthrough Video
• Installation
• License
• Contributing
• FAQs

🚀 Submission

Github Repo: https://github.com/VimukthiGunasekara/social-network-api

👤 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

📺 Walkthrough Video

Video

⚙️ Installation

Use your terminal to clone or download or copy the zip file to a directory of your choice. Then open the file in VS Code or whatever editor you use. In VS Code, open the terminal and navigate to Social Network API in the root directory and you need to start mongoDB Compass. After that run the following at the command line

npm init -y
npm install express
npm install mongoose
npm install moment

Then, Start the server

npm start

📑 License

Your repository is licensed under an mit open source license, so other people can contribute more easily.More information can be found by clicking this link.

🤝 Contributing

We are open to all kinds of contributions. If you want to:

• 🤔 Suggest a feature
• 🐛 Report an issue
• 📖 Improve documentation
• 👨‍💻 Contribute to the code

We are excited that you are reading this and are willing to contribute. No need to think big. Even a typo fix might save our day and make you a hero. Every contribution counts!

Feel free to check issues page

🤔 FAQs

Please contact me using the following links:

GitHub / Email: vimukthisadaruwan65@gmail.com