Mortar.js is an open source framework built with React that makes interacting and updating data quick, easy, and powerful. It can best be described as an Admin User Interface that allows developers to quickly and safely build sites to interface with an API without accessing the database directly.
This generator makes it extremely easy to begin a React & Mortar project by taking care of the directory structure, installing dependencies, and the build process. The end result will allow you to build using React, JSX, ES6, and — of course — Mortar.
- Yeoman and Gulp through
npm install -g yo gulp
npm install -g generator-mortarto install the generator.
yo mortarto start the generator.
- Follow the command line prompts. You will have the option to include authentication if your application & API requires it.
- Grab a cup of
☕️and relax while the generators churns.
- Scaffolding is done! Start the development server with
npm run open!
- Clone this repository.
npm installto install generator dev dependencies.
npm linkto install the mortar yeoman generator locally for testing.
- Test suite is managed by gulp and executed with
Mortar Project Directory Structure
The end result of this yeoman generator will produce the following project structure:
node_modulesInstalled third party packages including Mortar.js.
main.jsRequired entry point for Webpack
.gitignoreGit ignore rules for Mortar.js projects.
npmdependencies and commands to build / compile your application.