# dirrbick-notes

> This is a class project to create notes and retrieve in a backend mongo database

Latest version **1.0.6** (published 2021-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install dirrbick-notes
pnpm add dirrbick-notes
yarn add dirrbick-notes
bun add dirrbick-notes
```

Provides the command `notes`.

## 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.6 |
| Published | 2021-02-02 |
| First published | 2020-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kory Jackson |
| Maintainers | dirrbick |

## Links

- npm: https://www.npmjs.com/package/dirrbick-notes
- Repository: https://github.com/kory-jackson-401-advanced-javascript/notes
- Homepage: https://github.com/kory-jackson-401-advanced-javascript/notes#readme
- Issues: https://github.com/kory-jackson-401-advanced-javascript/notes/issues
- npm.io page: https://npm.io/package/dirrbick-notes

## Dependencies (7)

- [jest](https://npm.io/package/jest.md) ^26.4.0
- [jsdoc](https://npm.io/package/jsdoc.md) ^3.6.5
- [dotenv](https://npm.io/package/dotenv.md) ^8.2.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [mongoose](https://npm.io/package/mongoose.md) ^5.10.0
- [superagent](https://npm.io/package/superagent.md) ^6.0.0
- [@code-fellows/supergoose](https://npm.io/package/@code-fellows/supergoose.md) ^1.0.11

## Recent versions

- 1.0.6 (latest) — 2021-02-02
- 1.0.5 — 2020-08-24
- 1.0.4 — 2020-08-24
- 1.0.3 — 2020-08-23
- 1.0.2 — 2020-08-23
- 1.0.1 — 2020-08-22
- 1.0.0 — 2020-08-22

## README

# LAB - Class 01

## Project: Notesy

### Author: Kory Jackson

### Links and Resources

- [Class 01 Submission PR](https://github.com/kory-jackson-401-advanced-javascript/notes/pull/2)
- [Class 02 Submission PR](https://github.com/kory-jackson-401-advanced-javascript/notes/pull/3)
- [Class 03 Submission PR](https://github.com/kory-jackson-401-advanced-javascript/notes/pull/4)
- [Class 04 Submission PR](https://github.com/kory-jackson-401-advanced-javascript/notes/pull/5)
- [JSDocs](https://kory-jackson-401-advanced-javascript.github.io/notes/)

#### How to initialize/run your application (where applicable)

- Ensure you have NPM installed on your computer
- To install run **npm i -g dirrbick-notes**
- Once installed you can use any of the following commands
    - **notes --add/-a "your note" --category/-c "the category you want"**: To add your note run this command along with your specified category.
    - **notes --list/-l**: lists all of your notes.
    - **notes --list/-l --category/-c "category"**: lists specified notes in category 
    - **notes --delete/-d "note id"**: list your notes and if you want to delete one, copy the id and run this command. It will then be removed.

#### Tests

- [github Actions](https://github.com/kory-jackson-401-advanced-javascript/notes/actions)

#### UML

#### Class 03 UML
![](Assets/class03_UML.png)

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