Giter VIP home page Giter VIP logo

commently's Introduction

Commently

A simple text commentig app for the web.

Installation

This app is created with Meteor.js and utilizes rangy.

To install the app, first follow the instructions to install Meteor

curl https://install.meteor.com/ | sh

and then:

1. git clone https://github.com/valeviolin/commently.git
2. meteor npm install
3. meteor 

the following will have the app running on localhost:3000

Approach

The main logic of the app can be found in main.js.

The approach taken roughly follows the following:

  1. Before each action "restore" the DOM state of the text. E.g remove highlights
  2. For new comments, create a Mongo document with the comment's text and the serialized range of the selected text.
  3. After clicking on a comment, deserialize the range of the comment and highlight it.

There are some bugs here and there (which I could not spot easily) due to either rangy or myself not fully getting rangy's way of working.

TODOs

This is only tested on the latest Chrome browser.

  1. Introduce users and assign comments to users
  2. Reply/Accept/Ignore comments
  3. Make it usable on mobile.
  4. Problems with big DOMs?

commently's People

Contributors

valentin0h avatar

Stargazers

Roman avatar Sergi Trilles Oliver avatar

Watchers

 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.