Take notes with ease using Notus. Feel free to use either Markdown or HTML.
You really need these things:
~ $ git clone https://github.com/OnlyTwentyCharacters/notus
cd notus
npm install
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 data.gov | 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 | [email protected] |
| Mail Service Password | mailService.service.auth.pass |
password on service used to send mail | ididnothashmypassword |
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
- Node.js
- Express.js
- Passport.js
- EJS
- RethinkDB
- MongoDB
- SimpleMDE
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent