# not.us

> Take notes, real quick.

Latest version **1.9.1** (published 2017-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install not.us
pnpm add not.us
yarn add not.us
bun add not.us
```

## 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.9.1 |
| Published | 2017-05-20 |
| First published | 2017-05-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 23 |
| Known vulnerabilities | 0 (+28 in 6 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | OnlyTwentyCharacters |
| Maintainers | vexified |
| Keywords | notes, api, notus, express, rethinkdb, rethink, mongo |

## Links

- npm: https://www.npmjs.com/package/not.us
- Repository: https://github.com/OnlyTwentyCharacters/Notus
- Homepage: https://notus.cf
- Issues: https://github.com/OnlyTwentyCharacters/Notus/issues
- npm.io page: https://npm.io/package/not.us

## Dependencies (23)

- [ejs](https://npm.io/package/ejs.md) ^2.5.6
- [path](https://npm.io/package/path.md) ^0.12.7
- [async](https://npm.io/package/async.md) ^2.3.0
- [morgan](https://npm.io/package/morgan.md) ^1.8.1
- [express](https://npm.io/package/express.md) ^4.15.2
- [mongoose](https://npm.io/package/mongoose.md) ^4.9.9
- [passport](https://npm.io/package/passport.md) ^0.3.2
- [rethinkdb](https://npm.io/package/rethinkdb.md) ^2.3.3
- [simplemde](https://npm.io/package/simplemde.md) ^1.11.2
- [nodemailer](https://npm.io/package/nodemailer.md) ^4.0.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.17.1
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^7.4.0
- [semistandard](https://npm.io/package/semistandard.md) ^11.0.0
- [sync-request](https://npm.io/package/sync-request.md) ^4.0.2
- [whatwg-fetch](https://npm.io/package/whatwg-fetch.md) ^2.0.3
- [bcrypt-nodejs](https://npm.io/package/bcrypt-nodejs.md) 0.0.3
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.3
- [express-flash](https://npm.io/package/express-flash.md) 0.0.2
- [passport-http](https://npm.io/package/passport-http.md) ^0.3.0
- [rethinkdbdash](https://npm.io/package/rethinkdbdash.md) ^2.3.28
- [passport-local](https://npm.io/package/passport-local.md) ^1.0.0
- [express-session](https://npm.io/package/express-session.md) ^1.15.2
- [passport-local-mongoose](https://npm.io/package/passport-local-mongoose.md) ^4.0.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.9.1 (latest) — 2017-05-20
- 1.9.0 — 2017-05-20
- 1.8.0 — 2017-05-20
- 1.7.3 — 2017-05-20
- 1.7.2 — 2017-05-20
- 1.6.0 — 2017-05-20
- 1.5.7 — 2017-05-20

## README

<h1 align="center">Notus</h1>

<p align="center">
  <a href="https://www.npmjs.com/package/not.us"><img src="https://img.shields.io/npm/v/not.us.svg?style=flat-square" alt="npm version"></a>
  <a href="https://github.com/Flet/semistandard"><img src="https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square" alt="semistandard"></a>
  <a href="#"><img src="https://img.shields.io/travis/OnlyTwentyCharacters/Notus.svg?style=flat-square" alt="travis build"></a>
  <a href="http://spdx.org/licenses/MIT"><img src="https://img.shields.io/npm/l/not.us.svg?style=flat-square" alt="license"></a>
</p>

## Description
Take notes with ease using Notus. Feel free to use either Markdown or HTML.

## Requirements

You _really_ need these things:

<ul>
<li><a href="https://api.data.gov/signup/"> data.gov Key </a></li>
<li><a href="https://nodemailer.com/smtp/well-known/"> NodeMailer supported service </a></li>
<li><a href="https://rethinkdb.com/"> RethinkDB </a></li>
<li><a href="https://mongodb.com/"> MongoDB </a></li>
<li><a href="https://nodejs.org/en/download/"> Node.js 7.8+ & npm </a></li>
</ul>

## Installation
```
~ $ git clone https://github.com/OnlyTwentyCharacters/notus
cd notus
npm install
```

## Configuration

First clone the `config.js.example` file. 
```
~ $ cp config.js.example config.js
```

Fill in each of the values.

| Name | Key Name | Description | Example |
| -------- | -------- | -------- | -------- |
| Base Domain | `domains.base` | the link to your website without https:// (may include www) | `notus.cf`
| Mailing Domain | `domains.mail` | the domain email are sent from | `notus.cf`
| Site Domain | `domains.website` | full url to your website with the http:// | `https://notus.cf`
| Port | `port` | port number application runs on | `8080`
| Data.gov Key | `dataGovKey` | api key obtained from <a href="https://api.data.gov/">data.gov</a> | N/A
| Secret | `secret` | a random string used to sign cookies  | `asupercomplicatedstring`
| MongoDB Connection String | `database` | mongodb connection string | `mongodb://username:password@domain/database`
| RethinkDB Database Name | `rethinkdb.db` | name of database used in rethinkdb connections | `Notus`
| RethinkDB Hostname | `rethinkdb.servers.host` | hostname used in rethinkdb connections | `localhost`
| RethinkDB Port | `rethinkdb.servers.port` | port used in rethinkdb connections | `28015`
| Note Limit | `noteLimit` | maximum number of notes than can be created per user | `100`
| Mail Service | `mailService.service` | service used to send mail | `SendGrid`
| Mail Service Username | `mailService.service.auth.user` | username on service used to send mail | `mail@mail.domain.name`
| Mail Service Password | `mailService.service.auth.pass` | password on service used to send mail | `ididnothashmypassword`

## Deployment

Using a production manager for Node.js applications is recommended.

**With pm2:**
`~ $ pm2 start Notus.js `

**If you're just testing out Notus for a very short period of time, just do:**
`~ $ node Notus.js`

### Built with
* Node.js
* Express.js
* Passport.js
* EJS
* RethinkDB
* MongoDB
* SimpleMDE

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