https://github.com/mleftwich/socialapi

Back end API for social network
https://github.com/mleftwich/socialapi

Last synced: 7 days ago
JSON representation

Back end API for social network

• Host: GitHub
• URL: https://github.com/mleftwich/socialapi
• Owner: mleftwich
• Created: 2022-09-13T03:13:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-01T05:35:35.000Z (about 2 years ago)
• Last Synced: 2024-11-06T03:48:22.873Z (about 2 months ago)
• Language: JavaScript
• Size: 106 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

  ![MIT](https://img.shields.io/static/v1?label=License&message=MIT&color=green)

  # Social API

  

  ## Table of Contents

  * [Description](#description)

  * [Technologies](#technologies)

  * [Installation](#installation)

  * [Usage](#usage)

  * [Contributing](#contributing)

  * [Guidelines](#guidelines)

  * [Tests](#tests)

  * [License](#license)

  * [Questions](#questions)

---

  ## Description

  This is a backend server configured for use with a social network. All end points are functional and allow the options to create users and thoughts, add friends, and react to thoughts. Users and thoughts can be modified/updated, and you can view all users/thoughts or choose to view specific queries, with the ability to delete all reactions, friends, thoughts and users. 

  Created using mongodb and node.js, utilizing the express package and mongoose - an npm that allows easier operation and access of mongoose databases to perform CRUD operations on the server.

  

  View a working demonstration [here](https://drive.google.com/file/d/1_ZbT_gglbIKOSImLODueKwMQUfEyZYFn/view)

---

![screenshot](./assets/imgs/screenshot.png)

---

  ## Technologies

  * JavaScript

  * node.js

  * NoSQL

  

  ## Installation

   Visit the repository at [my github](https://github.com/mleftwich/SocialAPI) and clone the repo to your local machine.

  ## Usage

   Install npm(npm install in terminal) and use program like Insomnia/Postman to handle requests/endpoints.

  ## Contributing

   If you'd like to contribute, reach out through the email listed below.

  ## Guidelines

  Uses MongoDB - must have an instance on local machine to operate.

  ## Tests

  Tested endpoints with Insomnia.

  ## License

   Licensed under [MIT](https://opensource.org/licenses/MIT) 

   ---

  ## Questions

   For any questions you can find me at [GitHub](https://github.com/mleftwich) or email me at [[email protected]](mailto:[email protected])