1.9.1 • Published 7 years ago

not.us v1.9.1

Weekly downloads
6
License
MIT
Repository
github
Last release
7 years ago

Description

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

Requirements

You really need these things:

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.

NameKey NameDescriptionExample
Base Domaindomains.basethe link to your website without https:// (may include www)notus.cf
Mailing Domaindomains.mailthe domain email are sent fromnotus.cf
Site Domaindomains.websitefull url to your website with the http://https://notus.cf
Portportport number application runs on8080
Data.gov KeydataGovKeyapi key obtained from data.govN/A
Secretsecreta random string used to sign cookiesasupercomplicatedstring
MongoDB Connection Stringdatabasemongodb connection stringmongodb://username:password@domain/database
RethinkDB Database Namerethinkdb.dbname of database used in rethinkdb connectionsNotus
RethinkDB Hostnamerethinkdb.servers.hosthostname used in rethinkdb connectionslocalhost
RethinkDB Portrethinkdb.servers.portport used in rethinkdb connections28015
Note LimitnoteLimitmaximum number of notes than can be created per user100
Mail ServicemailService.serviceservice used to send mailSendGrid
Mail Service UsernamemailService.service.auth.userusername on service used to send mailmail@mail.domain.name
Mail Service PasswordmailService.service.auth.passpassword on service used to send mailididnothashmypassword

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