0

Braindump

BrainDump是一个简单，强大，开放的笔记平台，可以轻松整理您的生活。（BrainDump is a simple, powerful, and open note taking platform that makes it easy to organize your life.）

Github 資源庫
主要指標
  • 所有者: levlaz/braindump
  • 平台: Docker, Linux
  • 許可證: MIT License
  • 分類:
  • 主題:
  • 喜歡:
    0
      比較:

Github星跟蹤圖

BrainDump是一个简单，强大，开放的笔记平台，可以轻松整理您的生活。

特性
  • RESTful API（WIP）
  • 全面Markdown编辑
  • 完全Markdown观看
  • 通过电子邮件分享笔记
  • 将Notes分类到笔记本中
  • 使用标记对Notes进行分类
  • 全文检索
  • 将笔记标记为收藏夹

主要指標

概覽
名稱與所有者levlaz/braindump
主編程語言Python
編程語言Python (語言數: 7)
平台Docker, Linux
許可證MIT License
所有者活动
創建於2015-11-22 20:15:55
推送於2017-01-18 07:21:16
最后一次提交2017-01-17 23:21:16
發布數36
最新版本名稱v0.4.14 (發布於 )
第一版名稱v0.0.1-alpha (發布於 )
用户参与
星數526
關注者數16
派生數57
提交數601
已啟用問題?
問題數0
打開的問題數0
拉請求數118
打開的拉請求數0
關閉的拉請求數24
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?

DEPRECATED: Read more here and join me in using and contributing to Standard Notes instead.

braindump

BrainDump is a simple, powerful, and open note taking platform that makes it easy to organize your life.

Features

  • RESTful API (WIP)
  • Full Markdown Editing
  • Full Markdown Viewing
  • Share Notes via Email
  • Categorize Notes into Notebooks
  • Categorize Notes with Tags
  • Full Text Search
  • Mark notes as Favorites

Screenshots

Organize your Notes with Notebooks

Notebooks

Powerful Markdown based Editing with Prose Mirror

New Note

All of your Notes in One Place

All Notes

Development

The easiest way to hack on braindump is with Vagrant

Requirements

  1. VirtualBox
  2. Vagrant
  3. Git

Development Instructions

  1. Fork and Clone this repo locally
  2. cd into the new repo
  3. Run vagrant up
  4. The first time you run vagrant up the provisioner (scripts/bootstrap.sh) will run which takes a bit of time. Each subequent time will be much quicker.
  5. Run vagrant ssh to enter the Vagrant box.
  6. Go to the /vagrant directory with cd /vagrant which is a synced folder of your local git repo.
  7. Run scripts/start-dev.sh to start the application
  8. Go to localhost:5000 to view the app, any changes you make locally will be reflected in the Vagrant environment.

Deploying to Production

The only official method of deploying Braindump is with Docker. Braindump.pw is currently running on an Ubuntu 16.04 LTS server on Linode. You can view scripts/deploy.sh to see how braindump is currently being deployed to production via CircleCI.

Requirements

  1. Docker and Docker Compose
  2. SMTP (Required for Creating new Accounts and Sharing Notes)

Deployment Instructions

  1. Log into your Production Server and install Docker and Docker Compose

  2. Create a new directory for braindump mkdir -p /var/www/braindump

  3. Edit scripts/secrets.sh and add your site specific environment credentials.

  4. Edit etc/conf/nginx.conf and add your site specific nginx configuration

  5. From your local repo, send latest scripts to production Server

    rsync -avz scripts/ $USER@SERVER:/var/www/braindump/scripts/
rsync -avz etc/ $USER@SERVER:/var/www/braindump/etc/
scp docker-compose.yml $USER@SERVER:/var/www/braindump

  6. From your local repo, log into production server, pull and restart Docker

    ssh $USER@SERVER 'cd /var/www/braindump && docker-compose pull'
ssh $USER@SERVER 'cd /var/www/braindump && docker-compose build'
ssh $USER@SERVER 'cd /var/www/braindump && source scripts/secrets.sh && docker-compose up -d'

  7. (Optional) to set up automatic backups (every 6 hours) add the backup script to your crontab crontab scripts/braindump-backup

If all goes well, you will be able to navigate to $YOUR_SERVER in a browser and see the app. If you get a bad gateway error, or some other error try to run docker-compose in the foreground to get additional logging cd /var/www/braindump && source scripts/secrets.sh && docker-compose up