Git Product home page Git Product logo

social-network-api's Introduction

Application Logo

Social Network API

An API for a social network web application where users can share thoughts, connect with friends, and react to their friends' thoughts!

GitHub Follow Badge GitHub Repository Forks Badge GitHub Repository Stars Badge GitHub Repository Watchers Badge

Deployed URL Badge

DescriptionFeaturesInstallationUsageSupportContributingCreditsLicense

Description

Motivation For Project

Reason For Building Project

How To Use The Project, Any Obstacles That Had To Be Overcome During Dev

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

Back to Top

Features

  • Key Features

Back to Top

Installation

Installation Steps

Technologies

Express Badge Mongoose Badge

Technologies Used During Build

Back to Top

Usage

Instructions & Examples

Visuals

User API Endpoints

Insomnia User Endpoints

Friend API Endpoints

Insomnia Friend Endpoints

Thought API Endpoints

Insomnia Thought Endpoints

Reaction API Endpoints

Insomnia Reaction Endpoints

Back to Top

Support

Email Badge

Contact Information:

If you have any questions, or additional feedback, please feel free to contact me. I will get back to you as soon as possible.

Submit an Issue:

If you are experiencing an issue with this application, please submit an issue ticket.

Back to Top

Contributing

GitHub Repository Contributors Badge

This project is not allowing other contributors at this moment.

Back to Top

Credits

GitHub Badge

Here are listed the sources that helped make this project possible.

Authors

The following developers helped create this project:

Emily Simone - Main Developer

Repository Information

GitHub Repository Size Badge GitHub Repository Last Commit Date Badge GitHub Repository Commit Activity Badge

Back to Top

License

MIT License Badge

© 2024 Emily Simone

This application is licensed under the MIT License.

Back to Top

social-network-api's People

Contributors

emsim11 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.