Mortar JS

Mortar JS is an open source framework built with React that makes interacting and updating data quick, easy, & powerful. Mortar can best be described as an Admin UI or simple CMS. With Mortar developers can quickly build sites to interface with an API and allow users to safely interface with data.

Mortar is composed of multiple Bricks (components) that work together to display and edit data. Tables, modal windows, buttons, form inputs & more are all included. Checkout the demo to see the Bricks in action!

Table of Contents

1. Getting Started
2. Documentation
3. Demo
4. Contributing
5. Sponsors

Getting Started

Mortar is very easy to plug and play. We recommend using the Yeoman generator that we've created to get up and running in no time. If you need something more custom, you can follow our getting started guide to bootstrap Mortar into your workflow! Checkout the wiki for more information on developing with Mortar.

Automated Installation

The easiest way to get started is using the Mortar Yeoman Generator that we've created. Simply npm install -g generator-mortar then run yo mortar to get build a simple project scaffolding.

Manual Installation

If you like to have more manual control you can npm install mortarjs. This approach will require a little customization to get the framework bootstrapped. Check out the wiki page "Getting Stared" for more information.

Documentation

You can view the documentation online. This documentation was generated automatically using the js-doc blocks in the source files. For more extensive documentation and implementation examples, see the playground.

Documentation can also be generated locally by running npm run document in the Mortar JS root directory.

Demo

We've created a playground with examples of all the components that are included with Mortar, how they are used, and what they do. We're working on expanding this site to be useful to designers, managers, and developers alike. Right now, you can play with the basic components, but soon we'll show off all built-in configurations, as well as provide documentation with code blocks showing how to implement every example on the site.

The playground itself was also built with Mortar! Check out the /examples directory in this repo to view the source.

Contributing

Contributions come in many forms: code, documentation, issues, etc. We're open and excited about any contributions that you can offer. If you're not sure where to start, feel free to reach out to the team. Otherwise, just jump in!

If you contribute and your changes get merged into the project we will send you a free Mortar JS t-shirt! (while supplies last)

Sponsors

Mortar was developed for internal use Fuzz Productions. Now, Mortar's development is sponsored by Fuzz and maintained by open source contributors.