magickw/SocialNetworkAPI

This application is an API for a social network web application where users can share their thoughts, react to friends’ thoughts, and create a friend list.

Social Network API

Description

This application allows you to write notes, save notes and deletes that are being stored in a db.json file. It runs on node.js and uses express.js to route all the get, post and delete methods. This application is deployed through Heroku.

Table of Contents

• Description
• Table of Contents
• Installation
• Usage
• Demo
• Built With
• License
• Contributing
• Tests
• Questions

Installation

git clone the repo to your local machine. To use this application, run the following command to install the dependencies:

npm install
npm i moment
npm i mongoose

Then run the following command to seed the database:

node utils/seed

Usage

Type the following command in your termimal:

node index.js

Then open Insomnia and type http://localhost:3001/ to run this application on your local machine.

Demo

Below is the demostration of this application. Please click here for walk-through video.

⬆ back to top

Built With

• HTML
• CSS
• Javascript
• NodeJS
• ExpressJS

⬆ back to top

License

This application is licensed under MIT license.

⬆ back to top

Contributing

This application is developed by Baofeng Guo. If you would like to contribute it, please follow the guidelines for how to do so.

⬆ back to top

Tests

To run tests on the application, run

npm install jest

and then npm run test from the command line.

⬆ back to top

Questions

For any question, please contact me on GitHub: magickw or email me at peterguo1983@gmail.com.

⬆ back to top