https://github.com/ds0nt/forky-client

A Simple Mindmapping App.
https://github.com/ds0nt/forky-client

Last synced: 5 days ago
JSON representation

A Simple Mindmapping App.

• Host: GitHub
• URL: https://github.com/ds0nt/forky-client
• Owner: ds0nt
• Created: 2015-05-20T19:25:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-13T00:47:58.000Z (almost 9 years ago)
• Last Synced: 2024-08-01T12:35:06.714Z (3 months ago)
• Language: JavaScript
• Size: 469 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - ds0nt/forky-client - A Simple Mindmapping App. (others)

README

        
# Forky Client

**Forky** is an app for realtime collaborative mind-mapping. You can use it on [forky.io](http://forky.io).

The Forky Client is the front-end of forky. It should be used with a [Forky Server](http://github.com/21cdawn/forky-server). You can check out the full guide for deploying forky (here)[http://github.com/21cdawn/forky]. This Readme covers details specific to the client.

## Overview

Forky is a single-page application, built with React. It communicates using both websockets and ajax, and dynamically renders the resulting elements. Websockets transport realtime data, primarily chats and graph edits. AJAX is used for user authentication, and listing the maps. Realtime collaboration is built on ShareJS, but I would like to move away from ShareJS, as it is not well written or documented.

## Building Forky Client

Get git and nodejs installed if you don't have them.

```bash

 $ git clone https://github.com/21cdawn/forky-client

 # install the node dependencies

 $ cd forky-client

 $ npm install

 # build the client

 $ gulp build    # builds into 'dist' folder by default

```

## Development

*Placeholder for Development Instructions*