<commit_before># firenze.js

[![Build Status](https://secure.travis-ci.org/fahad19/firenze.png?branch=master)](http://travis-ci.org/fahad19/firenze) [![Coverage Status](https://coveralls.io/repos/fahad19/firenze/badge.svg?branch=master)](https://coveralls.io/r/fahad19/firenze?branch=master) [![npm](https://img.shields.io/npm/v/firenze.svg)](https://www.npmjs.com/package/firenze)

Install it with [npm](https://npmjs.com):

```
$ npm install --save firenze
```

Or [Bower](http://bower.io):

```
$ bower install --save firenze
```

---

firenze.js is a adapter-based object relational mapper targetting node.js, io.js and the browser.

#### Key features

* Written in ES6 (works in both node/io.js/browser)
* Adapter based structure to plug in any database
* Promise based workflow
* Strong validation support

The project is still in heavy development, and more features are expected to land in future releases.

#### Available adapters

* [Memory](https://github.com/fahad19/firenze-adapter-memory) (works in both node and the browser)
* [MySQL](https://github.com/fahad19/firenze-adapter-mysql)

#### Terminologies

Terminologies for developing with firenze.js can be broken down into a handful of items:

* Database
* Adapter
* Collection
* Model

Each of them are discussed in the documentation below.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Contents

- [Install](#install)<commit_msg>add localStorage adapter to the list.<commit_after># firenze.js

[![Build Status](https://secure.travis-ci.org/fahad19/firenze.png?branch=master)](http://travis-ci.org/fahad19/firenze) [![Coverage Status](https://coveralls.io/repos/fahad19/firenze/badge.svg?branch=master)](https://coveralls.io/r/fahad19/firenze?branch=master) [![npm](https://img.shields.io/npm/v/firenze.svg)](https://www.npmjs.com/package/firenze)

Install it with [npm](https://npmjs.com):

```
$ npm install --save firenze
```

Or [Bower](http://bower.io):

```
$ bower install --save firenze
```

---

firenze.js is a adapter-based object relational mapper targetting node.js, io.js and the browser.

#### Key features

* Written in ES6 (works in both node/io.js/browser)
* Adapter based structure to plug in any database
* Promise based workflow
* Strong validation support

The project is still in heavy development, and more features are expected to land in future releases.

#### Available adapters

* [Memory](https://github.com/fahad19/firenze-adapter-memory) (works in both node and the browser)
* [localStorage](https://github.com/fahad19/firenze-adapter-localstorage)
* [MySQL](https://github.com/fahad19/firenze-adapter-mysql)

#### Terminologies

Terminologies for developing with firenze.js can be broken down into a handful of items:

* Database
* Adapter
* Collection
* Model

Each of them are discussed in the documentation below.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
# Contents

- [Install](#install)
{'fraction_non_alphanumeric': 0.14175257731958762, 'fraction_numerical': 0.00902061855670103, 'mean_word_length': 4.58453237410072, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 17, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '387993', 'n_tokens_mistral': 1072, 'n_tokens_neox': 999, 'n_words': 277}