README.md 4.89 KB
Newer Older
Nick Busey's avatar
Nick Busey committed
1
2
3
4
| Travis                                                                                                                        |                                                                      Circle CI                                            |                                                                                                                                                              Coveralls |                                                                                                                              Codecov | Codacy                                                                                                                                                                                                                                                            |
| ----------------------------------------------------------------------------------------------------------------------------- | :-----------------------------------------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -----------------------------------------------------------------------------------------------------------------------------------: |  ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [![Build Status](https://travis-ci.org/NickBusey/BulletNotes.svg?branch=master)](https://travis-ci.org/NickBusey/BulletNotes) | [![CircleCI](https://circleci.com/gh/NickBusey/BulletNotes.svg?style=svg)](https://circleci.com/gh/NickBusey/BulletNotes) | [![Coverage Status](https://coveralls.io/repos/github/NickBusey/BulletNotes/badge.svg?branch=master)](https://coveralls.io/github/NickBusey/BulletNotes?branch=master) | [![codecov](https://codecov.io/gh/NickBusey/BulletNotes/branch/master/graph/badge.svg)](https://codecov.io/gh/NickBusey/BulletNotes) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8e7f3a2a82e74c5ebddc3253e89d09fd)](https://www.codacy.com/app/NickBusey/BulletNotes?utm_source=github.com&utm_medium=referral&utm_content=NickBusey/BulletNotes&utm_campaign=Badge_Grade) |

Nick Busey's avatar
Nick Busey committed
5
# BulletNotes
Nick Busey's avatar
Nick Busey committed
6

7
https://bulletnotes.io/
Nick Busey's avatar
Nick Busey committed
8

Nick Busey's avatar
Nick Busey committed
9
10
<p align="center">
  <a href="https://bulletnotes.io/">
NickBusey's avatar
NickBusey committed
11
    <img src="BulletNotesDemo.gif">
Nick Busey's avatar
Nick Busey committed
12
13
14
  </a>
</p>

Nick Busey's avatar
Nick Busey committed
15
## Goal
Nick Busey's avatar
Nick Busey committed
16

Nick Busey's avatar
Nick Busey committed
17
An open-source, fully featured note taking, journaling, self quantification app. Similar in many ways to Workflowy or Dynalist.
Nick Busey's avatar
Nick Busey committed
18

Nick Busey's avatar
Nick Busey committed
19
### Focus
Nick Busey's avatar
Nick Busey committed
20

Nick Busey's avatar
Nick Busey committed
21
* Privacy
Nick Busey's avatar
Nick Busey committed
22
 * You can run a copy on your own server. Own all your data.
Nick Busey's avatar
Nick Busey committed
23
* Data Portability
Nick Busey's avatar
Nick Busey committed
24
25
 * Nightly export to drop box is in a human friendly .txt file. You can copy/paste the export straight into other note taking apps such as Workflowy. Every extra feature beyond nested notes is implemented with hashtags, so no data is lost on export.
* Ease of Use
Nick Busey's avatar
Nick Busey committed
26
27
 * Point and click friendliness for less technical users.
 * API and CLI interface for more technical users.
28
29
 * Chat bot
 	* Telegram Interface
Nick Busey's avatar
Nick Busey committed
30

31
32
33
```
brew install NickBusey/Bulletnotescli/bulletnotescli
```
Nick Busey's avatar
Nick Busey committed
34
35


Nick Busey's avatar
Nick Busey committed
36
## User Guide, Planned Feature List, and Bug Tracker
Nick Busey's avatar
Nick Busey committed
37

38
https://bulletnotes.io/note/gPQcYmjmqwfnHeTWE/GjT4R6pMFA
Nick Busey's avatar
Nick Busey committed
39
40
41

## Local Development Instructions

42
Install the latest Node, NPM, and Meteor.
Nick Busey's avatar
Nick Busey committed
43
44
45
46
47

Clone the repo.

```
cd BulletNotes
Nick Busey's avatar
Nick Busey committed
48
touch settings.private.json
NickBusey's avatar
NickBusey committed
49
50
51
meteor npm install
meteor npm install --save-dev meteor-desktop
meteor npm install --save gm
Nick Busey's avatar
Nick Busey committed
52
53
54
npm start
```

55
That's it! Note: You may have to run this several times when first starting to get it to download everything.
Nick Busey's avatar
Nick Busey committed
56
57
58
59

## Heroku Deployment

Create a Heroku app. Add an mLab addon for your database. Fork this repo and deploy your forked branch to Heroku as normal, as per Heroku's documentation. Set your buildpack to https://github.com/AdmitHub/meteor-buildpack-horse.git
60

61
62
63
64
65
66
## Docker Deployment

There is a Docker image available, though it is fairly large (over 4GB) it does indeed work.

Easiest way to get running is to just do a `docker-compose up` in the root directory.

67
68
69
70
## Background Images

All images in public/img/bgs are CC0 License, Free for personal and commercial use, No attribution required

Nick Busey's avatar
Nick Busey committed
71
72
73
74
75
76
77
78
* Space - https://www.pexels.com/photo/rock-formation-during-night-time-167843/
* Field - https://www.pexels.com/photo/sky-field-agriculture-cornfield-7601/
* City - https://www.pexels.com/photo/aerial-architectural-design-architecture-buildings-373912/
* Mountain - https://www.pexels.com/photo/adventure-alpine-altitude-austria-355241/
* Abstract - https://www.pexels.com/photo/abstract-art-artistic-background-459799/
* Light - https://www.pexels.com/photo/abstract-art-blur-bulb-287748/
* Beach - https://www.pexels.com/photo/beach-calm-clouds-idyllic-457882/
* Snow - https://www.pexels.com/photo/snow-covered-ground-60561/
Nick Busey's avatar
Build    
Nick Busey committed
79