MEAN-R

Generator for MEAN clients, APIs, workers and distributed systems

Summary

This tool is designed to make the process of creating the various different components of a distributed system easy. You can create different clients, APIs and workers inside of a solution. These components will exist as separate projects inside of the solution. The generator will allow you to add these separate projects to GitHub, to make the process of managing developement very simple.

TODO: Talk about the philosophy

Assumptions

When using MEAN-R there are some assumptions made about your development process.

TODO: Talk about the use of Travis-CI, Newrelic and Heroku

Installing

npm install -g mean-r

Functions

• Create: Used for creating a solution, api, client or worker
• Build: Used for importing all projects into a solution after intial pull
• Add: Used for adding sub-items to clients, APIs or workers
• Import: Will import a project from GitHub using either a URL or by selecting from a list of team repositories

Getting Started

Before Creating a new solution you will need to make sure that you have the following tools installed on your machine

Git

brew install git

Heroku Toolbelt

Download

Create

To create a new solution run:

meanr create solution

Then follow the prompts.

TODO: Talk about files and structure

Creating a new API

To create a new API run:

meanr create api

TODO: talk about files and structure

Creating a new client

To create a new client run:

meanr create client

TODO: talk about files and structure

Creating a new worker

To create a new worker run:

meanr create worker

TODO: talk about files and structure

Build

If you have cloned a solution repository, you will need to pull in all of the associated with the solution. To do this run the following command inside of your solution's directory

meanr build

This will go through and import all of the projects from their github repositories

Add

TODO: Talk about adding modules to projects

Import

TODO: Talk about the import process

Creating New Templates

TODO: Talk about how templates are created and the slush configuration