• OVERVIEW
  • user story
  • acceptance criteria
  • killer list
• INSTALLATION
• USAGE
  • screenshot
  • demo
• TESTING
• SOURCES
• LICENSE
• LINKS
• CONNECT

SERIAL SOCIAL is an API for a social network web application where true crime fanatics can share their thoughts, react to friends' thoughts, and create a killer friend list. The app uses Express.js for routing, a MongoDB database, Mongoose as the ORM, and the Moment.js npm package for timestamp formatting.

The application is invoked using the following commands:

Clone the repository in your local development enviornment

git clone https://github.com/christiecamp/serial-social.git

Create a .env to secure your information

Ensure that you have installed MongoDB & MongoDB Compass onto your computer, and that the connection is live

Navigate to the CLI and input:

npm i express dotenv mongoose moment

INSTRUCTIONS:

1. Open the Integrated Terminal and follow the installation guidelines

2. Interact with SERIAL SOCIAL's back end with Insomnia or MongoDB Compass by testing the below:

   • GET all users & thoughts
   • GET user & thought by id
   • CREATE user, thought, reaction
   • UPDATE user, thought, friend, & reaction
   • DELETE user, thought, friend, & reaction

   view demo videos and testing for further help

screenshot demonstrates SERIAL SOCIAL's back end & testing of all routes with Insomnia

users

friends

thoughts

reactions

TESTING WITH INSOMNIA or MONGODB COMPASS:

There are different tools available that can test reading/writing operations in a web browser - in this application we use Insomnia, a REST client that makes it easy to send HTTP requests to an API and view response details, and MongoDB Compass the GUI for MongoDB.

1. After installing Insomnia, open a new document.

2. Interact with SERIAL SOCIAL's back end by testing the below commands:

GET all users, thoughts

http://localhost:3013/api/users/

http://localhost:3013/api/thoughts/

GET thought by id

http://localhost:3013/api/thoughts/659d7eac47d1a55210e92aca

CREATE reaction

http://localhost:3013/api/thoughts/659d93d6da28d9bb5489eb0d/reactions

{
  "reactionBody": " ",
  "username": " "
}

UPDATE user

http://localhost:3013/api/users/659d8a1ce2019aeeb57c5156

{
  "username": " ",
  "email": " "
}

DELETE friend

http://localhost:3013/api/users/userId/friends/friendId

Here's a list of technologies used:

1. Node.js - an open-source, cross-platform JavaScript runtime environment.

2. Express.js - a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.

3. MongoDB - a NoSQL database product that utilizes JSON-like documents with optional schemas.

4. Mongoose - a Node.js-based Object Data Modeling (ODM) library for MongoDB. It is akin to an Object Relational Mapper (ORM) such as Sequelize for MySQL relational databases.

5. Moment.js - JavaScript library that helps parse, validate, and manipulate date objects

6. Dotenv - a zero-dependency module that loads environment variables from a .env file into process.env.

7. Insomnia - an open source desktop application that assists in designing, debugging, and testing APIs (specifically in this instance, HTTP-based RESTful APIs).

8. MongoDB Compass - MongoDB's GUI tool for querying, optimizing, and analyzing data.

mit license

github repo

video demos:

• user demo

• thoughts demo

• reactions demo

• friends demo