# node-motivator

> OS notifications that give you motivation(s).

Latest version **1.0.1** (published 2016-03-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-motivator
pnpm add node-motivator
yarn add node-motivator
bun add node-motivator
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-03-22 |
| First published | 2016-03-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Chris Schmitz |
| Maintainers | cschmitz81 |

## Links

- npm: https://www.npmjs.com/package/node-motivator
- npm.io page: https://npm.io/package/node-motivator

## Dependencies (3)

- [repeat](https://npm.io/package/repeat.md) 0.0.6
- [motivations](https://npm.io/package/motivations.md) ^1.0.10
- [node-notifier](https://npm.io/package/node-notifier.md) ^4.5.0

## Recent versions

- 1.0.1 (latest) — 2016-03-22
- 1.0.0 — 2016-03-22

## README

# Node Motivator

Inspirational statements via OS notification from the [NodeTogether Motivations](https://github.com/NodeTogether/motivations) repository.

![demo](readmeAttachments/Motivator.gif)

Remind yourself that you can do it :)

## Prerequisites

This project requires [node.js and npm](https://nodejs.org/en/) (comes with node).

## Get up and running from npm

- Make your project folder:

        mkdir mycoolproject && cd mycoolproject

- Initilize your `package.json` file:

       npm init
       # Fill in fields or leave all blank to get default configuration

- Install and save motivator:

        npm install --save node-motivator

- Open a text editor and create an entry point (e.g.):

       touch index.js && atom .

- Require `node-motivator` and configure it (e.g.):

        // In index.js
        var Motivator = require('node-motivator')
        var motivator = new Motivator(5, 'mins')
        motivator.duration.measure = 20
        motivator.duration.unit = 'mins'

        motivator.motivateMe()

- Run it from the command line and feel motivated!:

        node index.js

- Open youtube and look up "Scareface (Push it to the Limit)" (e.g.):

        open https://www.youtube.com/watch?v=DZz3y6r-5H8


## Get up and running with example pulled from Github

- Clone this repo and cd into it:

        cd ~/Desktop
        git clone https://github.com/chris-schmitz/node-motivator motivator
        cd motivator

- Install the dependencies with npm:

        npm install

- Run the `test.js` file with node:

        node test.js

---
_Source: https://npm.io/package/node-motivator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
