Code Monkey home page Code Monkey logo

bear-plus's Introduction

Bear+

A web-based writing application with real-time collaboration and Markdown syntax support for crafting and sharing notes. Group and find note easily with hashtag and full text search. Inspired by Bear note and HackMD.

Homepage Intorduction

Test User:

Email: [email protected]

Password: bearplus

(Public note are view only for anonymous user, please sign in to test collaboration features!)

Table of Content

Features

Advanced Markup Editor

  • Text Style Rich Previews
  • Markdown Compatible Syntax
    • DONE: Heading, unordered list, ordered list, quote, code block
    • TODO: line separator, code, bold, italic, link, mark, etc.
  • JavaScript Code Syntax Highlight
  • In-line Drag and Drop Support for Images
  • Note Information Dashboard

Simple Note Organizing Tool

  • Categorize with Hashtags
  • Pin Note on Top
  • Find Note with Full-text Search
  • Archive and Trash Support

Realtime Collaboration

  • Simultaneous editing without conflict
  • Real-time Users' Cursor Display
  • Auto Update and Save
  • Share Note by Url
  • Simple Note Permission Setting
  • Inline Comment

Technologies

Architecture

Backend

  • Environment: Linux + Node.js
  • Framework: Express.js
  • Real-time Data Transport: Socket.io
  • User Authorization: Passport.js + Express Session
  • Server-side Renderer: EJS

Front-End

  • HTML
  • CSS
  • JavaScript + AJAX + jQuery
  • Module Bundler: Webpack
  • Rich-text Editor: ProseMirror

Operational transformation

Implemented Operational Transformation System by ProseMirror Collab Module.

Database

  • RDS + MySQL
  • ORM: Sequelize
  • Schema:

Networking

  • Protocol: HTTP & HTTPs
  • SSL Certificate: AWS Certificate Manager
  • DNS: Route53
  • Proxy server: Nginx

Tools

  • CI/CD: Jenkins + Docker
  • Test: Mocha + Chai + Sinon
  • Linter: ESLint

AWS Cloud Services

  • EC2 + ELB
  • S3 + CloudFront

Contact

Yen-Chen Kuo

[email protected]

bear-plus's People

Contributors

yk9331 avatar hackmd-deploy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.