-
Notifications
You must be signed in to change notification settings - Fork 241
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
Showing
6 changed files
with
355 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 | Original file line | Diff line number | Diff line change |
---|---|---|---|
|
@@ -7,3 +7,5 @@ v8.log | ||
.DS_Store | .DS_Store | ||
benchmark.js | benchmark.js | ||
analyse.r | analyse.r | ||
docs/html | |||
docs/man |
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 | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,17 @@ | |||
jugglingdb-changelog(3) - The History of JugglingDB | |||
=================================================== | |||
|
|||
## HISTORY | |||
|
|||
### upcoming release | |||
|
|||
### 0.2.1 | |||
|
|||
### 0.2.0 | |||
|
|||
### 0.1.27 | |||
### 0.1.23 | |||
### 0.1.21 | |||
### 0.1.1 | |||
### 0.0.4 | |||
### 0.0.2 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,9 @@ | |||
jugglingdb(3) index | |||
jugglingdb-changelog(3) changelog.3 | |||
jugglingdb-roadmap(3) roadmap.3 | |||
jugglingdb-validations(3) validations.3 | |||
jugglingdb-hooks(3) hooks.3 | |||
jugglingdb-schema(3) schema.3 | |||
jugglingdb-model(3) model.3 | |||
|
|||
jugglingdb-nano https://github.com/jugglingdb/nano-adapter |
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 | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,101 @@ | |||
JugglingDB(3) - cross-database ORM for nodejs and browser | |||
========================================================= | |||
|
|||
## DESCRIPTION | |||
|
|||
JugglingDB is cross-db ORM for nodejs, providing **common interface** to access | |||
most popular database formats. Currently supported are: mysql, sqlite3, | |||
postgres, couchdb, mongodb, redis, neo4j and in-memory-storage. | |||
|
|||
JugglingDB also works on client-side (using WebService and Memory adapters), | |||
which allows to write rich client-side apps talking to server using JSON API. | |||
|
|||
|
|||
## INSTALLATION | |||
|
|||
Use npm to install core package: | |||
|
|||
npm install jugglingdb --save | |||
|
|||
Alternatively you can install jugglingdb core from github: | |||
|
|||
npm install 1602/jugglingdb | |||
|
|||
Then install adapter for specific database, for example `jugglingdb-redis`: | |||
|
|||
npm install jugglingdb-redis | |||
|
|||
See jugglingdb-adapters(3) for list of available adapters. | |||
|
|||
## DOCUMENTATION | |||
|
|||
Autogenerated documentation available at [jsdoc.info/1602/jugglingdb](https://jsdoc.info/1602/jugglingdb). Human-written manual sections are: | |||
|
|||
* jugglingdb-schema(3): | |||
Everything about schema, data types and model definition. | |||
|
|||
* jugglingdb-model(3): | |||
Model methods, features and internals. | |||
|
|||
* jugglingdb-validations(3): | |||
Built-in validators, creating custom validations, syncronous and asyncronous | |||
object validation. | |||
|
|||
* jugglingdb-hooks(3): | |||
Hooks and object lifecycle. | |||
|
|||
## ADAPTERS | |||
|
|||
## CONTRIBUTION | |||
|
|||
## FUTURE | |||
|
|||
See jugglingdb-roadmap(3) and [github issues][issues] to catch up current | |||
development and see how you can help jugglingdb to grow up. | |||
|
|||
## BUGS | |||
|
|||
When you find issues, please report them: | |||
|
|||
* github/core: | |||
<https://github.com/1602/jugglingdb/issues> | |||
* github/adapters: | |||
<https://github.com/jugglingdb> | |||
* email: | |||
<compoundjs@googlegroups.com> | |||
|
|||
## HISTORY | |||
|
|||
See jugglingdb-changelog(3) | |||
|
|||
## LICENSE | |||
|
|||
JugglingDB has MIT license, see jugglingdb-license(3) for details. | |||
|
|||
## AUTHOR | |||
|
|||
* [blog](http://anatoliy.in/) | |||
* [github/1602](https://github.com/1602/) | |||
* [github/anatoliychakkaev](https://github.com/anatoliychakkaev/) | |||
* [twitter@1602](http://twitter.com/1602) | |||
* <mail@anatoliy.in> | |||
|
|||
## CONTRIBUTORS | |||
|
|||
### core contributors (more than 1%) | |||
410 Anatoliy Chakkaev 73.9% | |||
31 Sébastien Drouyer 5.6% | |||
25 1602 4.5% | |||
9 Muneeb Samuels 1.6% | |||
6 Henri Bergius 1.1% | |||
|
|||
### adapters maintainers | |||
|
|||
* [jugglingdb-nano] - [Nicholas Westlake](https://github.com/nrw) | |||
* [jugglingdb-mysql] - [dgsan](https://github.com/dgsan) | |||
* [jugglingdb-firebird] - [Henri Gourvest](https://github.com/hgourvest) | |||
|
|||
*NOTE:* Other adapters waits for their maintainers, drop a line to | |||
mail@anatoliy.in if you want to maintain some adapter on regular basis. | |||
|
|||
## SEE ALSO |
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 | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,29 @@ | |||
jugglingdb-roadmap - The Future of JugglingDB | |||
============================================= | |||
|
|||
## DOCUMENTATION | |||
|
|||
### ENGINE | |||
|
|||
* web | |||
* man | |||
|
|||
### SECTIONS | |||
|
|||
* hooks | |||
* validations | |||
* schema | |||
* model | |||
* adapters | |||
* testing | |||
|
|||
## MODEL CORE | |||
|
|||
* virtual attributes | |||
* object presentation modes | |||
* mass-assignment protection | |||
* destroy by query | |||
|
|||
## SCHEMA | |||
|
|||
* models merging |