Kurohyou/SocialAPI

An API for a social networking site

Social API

A proof of concept Social Networking API

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Contact
4. Acknowledgments

About The Project

This is a simple API proof of concept for a social networking website. It provides the ability to post thoughts (aka posts), reactions to those thoughts (aka comments), add/remove friends, and edit your user data, friends, and thoughts.

(back to top)

Built With

• Node
• Express.js
• MongoDB
• Mongoose

(back to top)

Getting Started

Installation

1. Clone the repository
2. Run npm i to install dependencies
3. Run npm run dev or npm start to boot the server up
4. Issue CRUD operations via your favorite api test service like insomnia or front end javascript.

(back to top)

Contact

Scott Casey - @kurohyoustudios - scaseydv@gmail.com

Project Link: https://github.com/Kurohyou/SocialAPI

(back to top)

Acknowledgments

Thanks to the University of Utah Full Stack web development course for instruction on how to create this.

This readme template adapted from the Best-README-Template by Othneil Drew. Readme generated by Genme! by Scott Casey.

(back to top)