Giter Club home page Giter Club logo

wiki's Introduction

Wiki

This project will provide a real-time collaborative wiki based on markdown, and Operational Transformation like the ShareJS wiki example.

TODO

  • make remote document updates trigger local markdown renderering
  • add some way to upload resources (i.e. images, pdfs, zips, etc). dropzone? or could just use
  • use browser editor (ACE, CodeMirror, etc) instead of text area

we should make an etherpad-based solution instead if you want these features

  • add login/authentication system (passport?)
  • investigate storing page versions
  • investigate storing author information (based on login/authentication)
  • try to use the latest ShareJS version (different API)

DONE

  • make ShareJS collaboration work
  • enable persistent pages via redis database
  • make editor side-by-side with rendered page (rather than up/down)
  • add some markdown-friendly css to make stuff look nice
  • create a better template page with a header and a footer

Installation and use

Run the install dependencies script. You may need to use sudo.

./install_dependencies.sh

If you are using ubuntu add the configuration to /etc/default/redis-server:

ULIMIT=10032

Start redis. This may create a file called appendonly.aof that holds the contents of the wiki.

redis-server --appendonly yes

Now, start the wiki server.

node server

(nodejs server on ubuntu)

Goto your browser and hit this url:

http://127.0.0.1:8000/wiki/foo

Useful Links

http://evanhahn.com/understanding-express
https://www.npmjs.org/package/connect-basic-auth

Reference Links

ShareJS wiki example
markdown
Operational Transformation
ShareJS
Showdown
redis
passport
ACE
CodeMirror
dropzone

wiki's People

Contributors

kybr avatar hannahwolfe avatar

Stargazers

Michael Anthony avatar

Watchers

charlie roberts avatar Andres Cabrera avatar  avatar Timothy Wood avatar basak alper avatar James Cloos avatar Pablo Colapinto avatar Graham Wakefield avatar Matt Wright avatar Donghao Ren avatar Lance Putnam avatar  avatar Michael Anthony avatar Kon Hyong Kim avatar Drew Waranis avatar  avatar Sihwa Park 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.