Attention this is under heavy development. Final structure and API are subject to change.

For detailed documentation and examples about this project, please visit the WIKI

• REST API documentation to understand how the dummy REST API that is included in the project works.
• Issues to get a feeling on where this library is heading to.

activerecord.js is an active record implementation for javascript. Quoting wikipedia:

Active record is an approach to accessing data in a database. A database table or view is wrapped into a class. Thus, an object instance is tied to a single row in the table. After creation of an object, a new row is added to the table upon save. Any object loaded gets its information from the database. When an object is updated the corresponding row in the table is also updated. The wrapper class implements accessor methods or properties for each column in the table or view.

There are a lot of active record libraries out there. However, none feels the same as using the equivelant in Rails, or in PHP Frameworks like Yii (which makes some sense, because working on the client side with data is a whole different story).

Of course, the first question is, why this library? Well, there is no reason. I just wanted to create a fun pet project for me and went ahead and created this lib. However, it does have a few points that differentiate from the others and can be appealing to you.

This is the prime requirement for the library. The developer should worry as less as possible about configuration, setting up syntax etc. He should be able to just use Models and develop fast.

You don't need to configure anything. The library makes the assumptions for you. Name your object "Car" and the REST endpoint will automatically be <base-url>/cars. Automatically your primary key will be a property named "id". And other little details to make your life easier

Even though everything works by convention, you have the power to configure everything, based on your needs. The library doesn't hard enforce anything.

You don't need to remember find, findByPK, findByAttribute etc. There is only one find function and does intelligent guess based on attributes. Both (new Car(5)).destroy() and Car.destroy(5) work. You don't need to remember a complex API, because just trying what comes natural usually works.