-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit d077462
Showing
6 changed files
with
472 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
/node_modules/ | ||
bower_components | ||
.directory | ||
.c9 | ||
.codio | ||
.settings | ||
build | ||
.vscode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2014 | ||
- Kevin Jahns <[email protected]>. | ||
- Chair of Computer Science 5 (Databases & Information Systems), RWTH Aachen University, Germany | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# IndexedDB database adapter for [Yjs](https://github.com/y-js/yjs) | ||
|
||
Use the IndexedDB database adapter to store your shared data persistently in the browser. The next time you join the session, your changes will still be there. | ||
|
||
* Minimizes the amount of data exchanged between server and client | ||
* Makes offline editing possible | ||
* Not supported by all browsers (see [mdn](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)) | ||
|
||
## Use it! | ||
Install this with bower or npm. | ||
|
||
##### Bower | ||
``` | ||
bower install y-indexeddb --save | ||
``` | ||
|
||
##### NPM | ||
``` | ||
npm install y-indexeddb --save | ||
``` | ||
|
||
### Example | ||
|
||
``` | ||
Y({ | ||
db: { | ||
name: 'indexeddb' | ||
}, | ||
connector: { | ||
name: 'websockets-client', // choose the websockets connector | ||
// name: 'webrtc' | ||
// name: 'xmpp' | ||
room: 'Textarea-example-dev' | ||
}, | ||
sourceDir: '/bower_components', // location of the y-* modules | ||
share: { | ||
textarea: 'Text' // y.share.textarea is of type Y.Text | ||
} | ||
// types: ['Richtext', 'Array'] // optional list of types you want to import | ||
}).then(function (y) { | ||
// bind the textarea to a shared text element | ||
y.share.textarea.bind(document.getElementById('textfield')) | ||
} | ||
``` | ||
|
||
## License | ||
Yjs is licensed under the [MIT License](./LICENSE). | ||
|
||
<[email protected]> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
/* eslint-env node */ | ||
|
||
var gulp = require('gulp') | ||
var $ = require('gulp-load-plugins')() | ||
var runSequence = require('run-sequence').use(gulp) | ||
|
||
require('../yjs/gulpfile.helper.js')(gulp, { | ||
polyfills: [], | ||
entry: './src/IndexedDB.js', | ||
targetName: 'y-indexeddb.js', | ||
moduleName: 'y-indexeddb', | ||
specs: [] | ||
}) | ||
|
||
gulp.task('default', ['updateSubmodule'], function (cb) { | ||
gulp.src('package.json') | ||
.pipe($.prompt.prompt({ | ||
type: 'checkbox', | ||
name: 'tasks', | ||
message: 'Which tasks would you like to run?', | ||
choices: [ | ||
'test Test this project', | ||
'dev:browser Watch files & serve the testsuite for the browser', | ||
'dev:nodejs Watch filse & test this project with nodejs', | ||
'bump Bump the current state of the project', | ||
'publish Publish this project. Creates a github tag', | ||
'dist Build the distribution files' | ||
] | ||
}, function (res) { | ||
var tasks = res.tasks.map(function (task) { | ||
return task.split(' ')[0] | ||
}) | ||
if (tasks.length > 0) { | ||
console.info('gulp ' + tasks.join(' ')) | ||
runSequence(tasks, cb) | ||
} else { | ||
console.info('Ok, .. goodbye') | ||
} | ||
})) | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
{ | ||
"name": "y-indexeddb", | ||
"version": "8.1.0", | ||
"description": "IndexedDB database adapter for Yjs", | ||
"main": "./src/IndexedDB.js", | ||
"scripts": { | ||
"test": "node --harmony ./node_modules/.bin/gulp test", | ||
"lint": "./node_modules/.bin/standard" | ||
}, | ||
"pre-commit": [ | ||
"lint", | ||
"test" | ||
], | ||
"standard": { | ||
"parser": "babel-eslint", | ||
"ignore": [ | ||
"build/**", | ||
"dist/**", | ||
"./y.js", | ||
"./y.js.map" | ||
] | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/y-js/y-indexeddb.git" | ||
}, | ||
"keywords": [ | ||
"Yjs", | ||
"OT", | ||
"Collaboration", | ||
"Synchronization", | ||
"ShareJS", | ||
"Coweb", | ||
"Concurrency" | ||
], | ||
"author": "Kevin Jahns <[email protected]>", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/y-js/yjs/issues" | ||
}, | ||
"homepage": "http://y-js.org", | ||
"devDependencies": { | ||
"babel-eslint": "^4.1.4", | ||
"babel-plugin-transform-runtime": "^6.1.18", | ||
"babel-preset-es2015": "^6.1.18", | ||
"babel-runtime": "^6.1.18", | ||
"babelify": "^7.2.0", | ||
"gulp": "^3.9.0", | ||
"gulp-load-plugins": "^1.1.0", | ||
"gulp-prompt": "^0.1.2", | ||
"pre-commit": "^1.1.2", | ||
"run-sequence": "^1.1.4", | ||
"standard": "^5.3.1" | ||
}, | ||
"peerDependencies": { | ||
"yjs": "^11.0.0 && >=11.2.0" | ||
}, | ||
"dependencies": { | ||
"level": "^1.4.0", | ||
"level-sublevel": "^6.5.4" | ||
} | ||
} |
Oops, something went wrong.