README.md

RESTful app

This is a demonstration project. It doesn't intend to deliver any final product. Purpose is to deliver an MVP built on MEAN stack.

MongoDB and Mongoose

This project uses MongoDB Atlas client and therefore Mongoose JavaScript library in order to accomplish a database connection. Therefore, you need to create an .env file in the root folder (which is ignored in .gitignore) and append

• DB_CONNECTION => your database connection string

and

• DB_CONNECTED_MSG => your custom connected to database message (shown in console)

Constants

hideNotification ⇒ Object

Hide notification.

showNotification ⇒ Object

Show notification.

hideNotification ⇒ Object

Hide notification.

Kind: global constant
Returns: Object - An object with data, context and typeprops andisRegistered`.

Param	Type	Default	Description
id	String		a unique identifier for your notification Defaults to 1500 for video context or 3000 otherwise.
[context]	String	NOTIFICATION_CONTEXTS	Context of the notification popup. One of PAGE or VIDEO_STREAM options. It determines the popups location.

showNotification ⇒ Object

Show notification.

Kind: global constant
Returns: Object - An object with data, context and type` props.

Param	Type	Default	Description
[data.customIcon]	String		A custom HTML string that represents the icon of the notification header.
[data.header]	String		notification header
[data.id]	String		a unique identifier for your notification
[data.message]	String		notification message
[data.showClose]	Boolean		State ofthe close button. Defaults to false otherwise if explicitly set to true will force the render of close the button.
[data.timeout]	Number		Explicit given timeout number.
[data.id]	String		a unique identifier for your notification Defaults to 1500 for video context or 3000 otherwise.
[context]	String	NOTIFICATION_CONTEXTS	Context of the notification popup. One of PAGE or VIDEO_STREAM options. It determines the popups location.