Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 2.58 KB

README.md

File metadata and controls

84 lines (62 loc) · 2.58 KB

Azul

NPM version Build status Code Climate Coverage Status Dependencies devDependencies

Azul has been built from the ground up to be the most expressive ORM for Node.js.

Get Started

$ npm install azul -g
$ npm install azul
$ azul init

The current release of Azul.js is a functional alpha. We're looking for feedback at this point, so please look at the docs and give it a try.

We're focusing on creating an expressive, well documented public API and reaching feature parity with other ORM tools. If you're interested in helping, please reach out.

Addons

A few additional components that you can use with Azul.js are:

Testing

Simply run npm test to run the full test suite.

This build currently connects to databases for testing purposes. To replicate this on your machine, do the following:

Postgres

$ createuser -s root
$ psql -U root -d postgres
> CREATE DATABASE azul_test;
> \q

MySQL

$ mysql -u root
> CREATE DATABASE azul_test;
> exit

Documentation

Generate and access documentation locally:

$ jsdoc --private -c jsdoc.json
$ open out/index.html

License

This project is distributed under the MIT license.