A slush generator to scaffold MEAN Apps. Inspired by http://meanjs.org
npm install slush-meanjs
> A slush generator to scaffold MEAN Apps
Inspired by MEAN
Install slush-meanjs globally:
``bash`
$ npm install -g slush-meanjs
Remember to install gulp and slush globally as well, if you haven't already:
`bash`
$ npm install -g gulp slush
Create a new folder for your project:
`bash`
$ mkdir my-slush-meanjs
Run the generator from within the new folder:
`bash`
$ cd my-slush-meanjs && slush meanjsRun the app
To run the app , first make sure mongoDB is running (`$ mongod`) then
`bash`
$ gulp
and navigate to http://localhost:3000`
To generate minified js & css files inside the public/dist folder, run
`bash`
$ gulp build
To lint files
`bash`
$ gulp lint
To run tests
`bash`
$ gulp test
| Feature | Command |
| MEAN Application generator | slush meanjs |
| CRUD Module sub-generator | slush meanjs:crud-module {{module-name}} |
| AngularJs Module sub-generator | slush meanjs:angular-module {{module-name}} |
| AngularJs Route sub-generator | slush meanjs:angular-route {{route-name}} |
| AngularJs Controller sub-generator | slush meanjs:angular-controller {{controller-name}} |
| AngularJs View sub-generator | slush meanjs:angular-view {{view-name}} |
| AngularJs Service sub-generator | slush meanjs:angular-service {{service-name}} |
| AngularJs Directive sub-generator | slush meanjs:angular-directive {{directive-name}} |
| AngularJs Filter sub-generator | slush meanjs:angular-filter {{filter-name}} |
| AngularJs Config sub-generator | slush meanjs:angular-config {{config-name}} |
| AngularJs Test sub-generator | slush meanjs:angular-test {{controller-name}} |
| Express Model sub-generator | slush meanjs:express-model {{model-name}} |
| Express Controller sub-generator | slush meanjs:express-controller {{controller-name}} |
| Express Routes sub-generator | slush meanjs:express-route {{route-name}} |
| Express Test sub-generator | slush meanjs:express-test {{model-name}} |
Note: Generators are to be run from the root directory of your app.
The application generator will help you create a fresh copy of a MEAN.JS application in your working folder. To create your MEAN application, navigate to a new project folder, and then use slush meanjs to generate your application:
`
$ slush meanjs
The generator will ask you a few questions about your new application and will generate it for you. When the installation process is over, you will be able to use gulp to run your new MEAN application:
`
$ gulp
Now, the application generator does a great job scaffolding a whole application, but daily work requires us to repeat a lot of structured code. For this purpose we provided you with some sub-generators to help you speed up your development.
The CRUD module sub-generator will help you create a new CRUD module, similar to the article sample provided with the project. To create a new CRUD module you will need to use slush meanjs again:
`
$ slush meanjs:crud-module
This will create both AngularJS and Express files supporting full CRUD functionality, and add the Karma and Mocha tests.
Note: Don’t forget to use your module name as an argument when calling the CRUD module sub-generator.
Another redundant task is creating a new AngularJS module structure. For this purpose you can use the Angular module sub-generator. It will create the proper folder structure for you and the module initialization file. Creating a new AngularJS module is simple:
`
$ slush meanjs:angular-module
The sub-generator will ask for more information about your folder structure, and will create the empty new AngularJS module. Now, to fill that new module with your business logic, we provided you with several AngularJS entities sub-generators.
To construct your module you will often need to create a new route. The AngularJS route sub-generator will help you create a view, controller and a proper route in your module routes.js file. If it can’t find the module routes file the sub-generator will create one for you. Creating a new AngularJS route will involve executing this command:
`
$ slush meanjs:angular-route
The sub-generator will ask for more information about your controller, view and routing URL, and will generate the appropriate files for you.
The AngularJS Controller sub-generator will create a new AngularJS controller in the specified module's controllers folder. To create a new AngularJS controller run slush meanjs again by using this command:
`
$ slush meanjs:angular-controller
The sub-generator will ask you for the module name under which you would like to create your new controller, and will create a new AngularJS controller file in that module controllers folder and a test file in the tests folder.
Don’t forget! This time you pass the controller name as an argument.
Once you have your controller file ready, you may want to add a view that makes use of this controller. The AngularJS view sub-generator will create a new AngularJS view in the specified module's views folder, and will allow you to add a route definition for it. To create a new AngularJS view you will need to execute this command:
`
$ slush meanjs:angular-view
The sub-generator will ask you for the module name under which you would like to create your new view, and some additional routing information. It will then create a new view file in that module's views folder and add a routing state to the module routes.js file. If it can’t find the module routes file it will create one for you.
The AngularJS service sub-generator will create a new AngularJS service in the specified module's services folder. To create a new AngularJS service you will need to execute this command:
`
$ slush meanjs:angular-service
The sub-generator will ask you for the module name under which you would like to create your new service, and will create a new AngularJS service file in that module's services folder.
The AngularJS directive sub-generator will create a new AngularJS directive in the specified module's directives folder. Creating a new AngularJS directive should already look familiar:
`
$ slush meanjs:angular-directive
The sub-generator will ask you for the module name under which you would like to create your new directive, and will create a new AngularJS directive file in that module's directives folder.
The AngularJS filter sub-generator will create a new AngularJS filter in a specified module's filters folder. To create a new AngularJS filter you need to call slush meanjs again:
`
$ slush meanjs:angular-filter
The sub-generator will ask you for the module name under which you would like to create your new filter, and will create a new AngularJS filter file in that module filters folder.
The AngularJS config sub-generator will create a new AngularJS config section in a specified module's config folder. To create a new AngularJS config file just call slush meanjs:
`
$ slush meanjs:angular-config
The sub-generator will ask you for the module name under which you would like to create your new config, and will create a new AngularJS config file in that module's config folder.
Your MEAN application comes pre-bundled with the Karma test runner and Jasmine testing framework. To test your AngularJS controllers you’ll need to create a test file, which Karma will later use to run the tests. For this purpose we provided you with the AngularJS test sub-generator. Creating a new AngularJS test is effortless, just execute this command:
`
$ slush meanjs:angular-test
This will create a test file for your controller, and if the sub-generator doesn’t find the specified controller file, it will create one for you.
Don’t forget! You're suppose to pass the controller name as an argument.
Often you will find the need to just create a single Express model. The Express model sub-generator will help you with creating an Express model in the app/models folder. To create a new model just use slush meanjs:
`
$ slush meanjs:express-model
This will create a new empty model in the app/models folder and a test file in the app/tests folder.
Note: It is recommended you avoid naming your model in plural form and use a singular form instead. i.e article and not articles
Another recurring task is creating an empty Express controller. The Express controller sub-generator will help you with creating an Express controller in the app/controllers folder. To create a new controller just use slush meanjs:
`
$ slush meanjs:express-controller
This will create a new empty controller in the app/controllers folder.
To make HTTP requests to your controller methods you will need to use a routing file in the app/routes folder. The Express routes sub-generator will help you to add a new empty routes file. To create a new routes file execute this slush meanjs command:
`
$ slush meanjs:express-route
This will create a new empty route file in the app/routes folder.
Your MEAN application comes pre-bundled with the Mocha testing framework. To test your Express models you’ll need to create a new test file, which Mocha will use while running tests. For this purpose we provided you with the Express test sub-generator. Creating a new Express test is easy, just execute this command:
`
$ slush meanjs:express-test
This will create a test file for your Express model, and if the sub-generator doesn’t find the specified model, it will create one for you.
Don’t forget! You're suppose to pass the model name as an argument.
Slush is a tool that uses Gulp for project scaffolding.
Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.
To find out more about Slush, check out the documentation.
See the CONTRIBUTING Guidelines
The MIT License
Copyright (c) 2014, Arvind Ravulavaru
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.