lux-framework/README.md

# [![Lux](https://lux.postlight.com/src/components/Sidebar/logo.svg)](https://lux.postlight.com)

[![CircleCI branch](https://img.shields.io/circleci/project/github/postlight/lux/master.svg?style=flat-square)](https://circleci.com/gh/postlight/lux/tree/master) [![AppVeyor](https://img.shields.io/appveyor/ci/zacharygolba/lux/master.svg?style=flat-square)](https://ci.appveyor.com/project/zacharygolba/lux/branch/master) [![Codecov branch](https://img.shields.io/codecov/c/github/postlight/lux/master.svg?style=flat-square)](https://codecov.io/gh/postlight/lux)
 [![David](https://img.shields.io/david/postlight/lux.svg?style=flat-square)](https://david-dm.org/postlight/lux) [![npm](https://img.shields.io/npm/v/lux-framework.svg?style=flat-square)](https://www.npmjs.com/package/lux-framework) [![Gitter](https://img.shields.io/gitter/room/postlight/lux.svg?style=flat-square)](https://gitter.im/postlight/lux)

A MVC style framework for building highly performant, large scale JSON APIs that anybody who knows the JavaScript language and its modern features will understand.

\* _Inspired by [Rails](https://github.com/rails/rails/), [Ember](http://emberjs.com/), and [React](https://facebook.github.io/react/)._

**Disclaimer:**

This isn't another wrapper around [Express](http://expressjs.com/) or a framework for building frameworks. This also isn't a replacement for server-side frameworks that render DHTML.

[Check out the Medium Article!](https://trackchanges.postlight.com/not-another-node-js-framework-33103ebeedf8)

## What?

### Features

*   Automatic CRUD actions in controllers
*   Automatic pagination, sorting, filtering via query params in controllers
*   CLI for eliminating boiler plate
*   [JSON API](http://jsonapi.org/) 1.0 compliant out of the box
*   Optimized database queries based on serialized attributes and associations
*   Highly extensible - just write reusable JavaScript functions
*   Pairs nicely with client-side JavaScript applications 🍷
*   Easy to contribute
*   Routes are stored and accessed via a `Map` not an `Array`
*   Embraces ES2015 and beyond
    *   Classes
    *   Modules
    *   Promises & async/await
    *   Arrow Functions
    *   etc.


### Philosophies

##### Minimal API surface area

Lux uses JavaScript's standard library rather than creating a ton of functions you'll have to learn and remember.

After your learn how to use it, you'll rarely need to look at the docs.

##### Pure functions are awesome

Or more appropriately somewhat pure functions are awesome.

Serving content is done by returning objects, arrays, or other primitives rather than calling `res.end(/* content */);` and returning nothing.

##### Convention over configuration

[Rails](http://rubyonrails.org/) and [Ember](http://emberjs.com/) are great because they make hard decisions for you and make it possible to submit a PR on your first day at a new company. This is rare with Node server frameworks.


## Why?

Frameworks like Rails are pretty great. You can build amazing applications in a reasonable amount of time without a ton of developers working on a project. They have their limitations though. They can be slow and sometimes hard to scale. Not to mention WebSocket support being so-so.

##### Node to the rescue.

It's fast, it allows the developer to get low level with a relatively simple API, WebSockets are stable and supported out of the box, and last but not least it's just JavaScript.

##### Not so fast (metaphorically speaking).

The last bit there "It's just JavaScript" has actually been somewhat of a double-edged sword. This has positioned Node as a "great prototyping tool" or "only used for micro services."

I can somewhat see why people would think that when returning a list of the first 10 records from a SQL database table looks like this:

```javascript
app.get('/posts', (req, res) => {
  Post.findAll()
    .then(posts => {
      res.status(200).json(posts);
    }, err => {
      console.error(err);
      res.status(500).send(err.message);
    });
});
```

Could you imagine how ugly that gets when you have to implement pagination, filtering, sorting, or—better yet—formatting the response for JSON API?

Also, where does that code live? In what file and folder would I find it? What pattern do you use for organizing this code?

😲Ok ok give me back Rails I'll worry about performance and scaling later. After all, premature optimization is the root of all evil.

##### Problem.resolve();

Shouldn't there be a better way to do this? Can't I just return a promise or a JavaScript primitive instead of basically using the native Node http server API?

Fortunately ES2015+ has introduced great new features to the JavaScript language, especially when it comes to meta programming.

With Lux your code from before can now look like this:

```javascript
class PostsController extends Controller {
  index(req, res) {
    return Post.all();
  }
}
```

Except CRUD actions are taken care of automatically so it would actually look like this:

```javascript
class PostsController extends Controller {

}
```

It's about time a Node server framework learned something from client-side JS frameworks.


## How?

### Installation

```bash
npm install -g lux-framework
```

### Creating Your First Project

Use the `new` command to create your first project.

```bash
lux new <app-name>
```

### Running

To run your application use the `serve` command.

```bash
cd <app-name>
lux serve
```

For more information checkout out the [Guides](https://lux.postlight.com/).


## Benchmarks

[**postlight/lux-benchmarks**](https://github.com/postlight/lux-benchmarks)


## Contributing

### Installation

```bash
git clone https://github.com/postlight/lux
cd lux
npm install
```

### Testing

```bash
git clone https://github.com/postlight/lux

# Install Lux dependencies
cd lux
npm install

# Install test app dependencies
cd test/test-app
npm install

# Run the test suite
cd ../../
npm test
```

## Useful Links

*   [JSON API](http://jsonapi.org/)
*   [Knex.js](http://knexjs.org/)
*   [Chai](http://chaijs.com/) / [Mocha](http://mochajs.org/)