Skip to content

Latest commit

 

History

History
executable file
·
119 lines (82 loc) · 3.95 KB

README.md

File metadata and controls

executable file
·
119 lines (82 loc) · 3.95 KB

Gitter NPM version Build Status Test Coverage Dependency Status Follow @fabrix-app on Twitter

Fabrix is a strongly typed modern web application framework for Node.js. It builds on the pedigree of Rails and Grails to accelerate development by adhering to a straightforward, convention-based, API-driven design philosophy.

Getting Started

Install

The Fabrix CLI is still under development so the following is a placeholder.

$ npm install @fabrix/fab-cli

Start Sewing

Fabrix uses a CLI to generate scaffolding for new applications, and to create resources inside the application. (TODO)

$ fab --help

Usage:
  fab

Generators:

  Create New Model
    fab model <model-name>

  Create New Controller
    fab controller <controller-name>

  Create New Policy
    fab policy <policy-name>

  Create New Service
    fab service <service-name>
    
  Create New Spool
      fab spool <spool-name>

Run

Once installation is complete, begin your journey!

$ node server.js

Happy Fabrix!

Spools

Spools extend the framework's capabilities and allow developers to leverage existing ecosystem tools through a simple and well-defined API. New features, behavior, APIs, and other functionality can be added to the Fabrix framework through Spools.

Many Fabrix installations will include some of the following Spools:

Compatibility

  • Windows, Mac, and Linux
  • Node 8.0 and newer

Documentation

See fabrix.app/doc for complete documentation.

More Resources

Tutorials

Videos

Support

FAQ

See https://github.com/fabrix-app/fabrix/wiki/FAQ

Contributing

We love contributions! Please check out our Contributor's Guide for more information on how our projects are organized and how to get started.

License

MIT

Legacy

Fabrix would not have been possible without the substantial work done by the Trails.js team. While Fabrix maintains a different code base and system of best practices, none of this would have been possible without the contributions from the Trails community.