Yeoman generator for creating MEAN stack applications, using MongoDB, Express, AngularJS, and Node - lets you quickly set up a project following best practices.
Source code: https://github.com/DaftMonk/fullstack-demo
Install yo, grunt-cli/gulp-cli, bower, and generator-angular-fullstack:
npm install -g yo grunt-cli gulp-cli bower generator-angular-fullstack
Make a new directory, and cd into it:
mkdir my-new-project && cd $_
Run yo angular-fullstack, optionally passing an app name:
yo angular-fullstack [app-name]
Run grunt for building, grunt serve for preview, and grunt serve:dist for a preview of the built app.
- MongoDB - Download and Install MongoDB - If you plan on scaffolding your project with mongoose, you'll need mongoDB to be installed and have the
mongodprocess running.
General
- Build Systems:
Grunt,Gulp - Testing:
JasmineMocha + Chai + Sinon- Chai assertions:
ExpectShould
- Chai assertions:
Client
- Scripts:
Babel,TypeScript - Markup:
HTML,Jade - Stylesheets:
CSS,Stylus,Sass,Less - Angular Routers:
ngRoute,ui-router - CSS Frameworks:
Bootstrap- Option to include
UI Bootstrap
- Option to include
Server
- Scripts:
Babel - Database:
None,MongoDB,SQL- Authentication boilerplate:
Yes,No - oAuth integrations:
FacebookTwitterGoogle - Socket.io integration:
Yes,No
- Authentication boilerplate:
A grunt task looks for new files in your client/app and client/components folder and automatically injects them in the appropriate places based on an injection block.
lessfiles intoclient/app/app.lessscssfiles intoclient/app/app.scssstylusfiles intoclient/app/app.stylcssfiles intoclient/index.htmljsfiles intoclient/index.htmlbabeltempjsfiles intoclient/index.html
Available generators:
- App
- Server Side
- Client Side
- Deployment
Sets up a new AngularJS + Express app, generating all the boilerplate you need to get started.
Usage:
Usage:
yo angular-fullstack:app [options] [<name>]
Options:
-h, --help # Print the generator's options and usage
--skip-cache # Do not remember prompt answers Default: false
--skip-install # Do not install dependencies Default: false
--app-suffix # Allow a custom suffix to be added to the module name Default: App
Arguments:
name Type: String Required: falseExample:
yo angular-fullstackGenerates a new API endpoint.
Usage:
Usage:
yo angular-fullstack:endpoint [options] <name>
Options:
-h, --help # Print the generator's options and usage
--skip-cache # Do not remember prompt answers Default: false
--route # URL for the endpoint
--models # Specify which model(s) to use Options: mongoose, sequelize
--endpointDirectory # Parent directory for enpoints
Arguments:
name Type: String Required: trueExample:
yo angular-fullstack:endpoint message
[?] What will the url of your endpoint be? /api/messagesProduces:
server/api/message/index.js
server/api/message/index.spec.js
server/api/message/message.controller.js
server/api/message/message.integration.js
server/api/message/message.model.js (optional)
server/api/message/message.events.js (optional)
server/api/message/message.socket.js (optional)
Generates a new route.
Example:
yo angular-fullstack:route myroute
[?] What module name would you like to use? myApp
[?] Where would you like to create this route? client/app/
[?] What will the url of your route be? /myrouteProduces:
client/app/myroute/myroute.js
client/app/myroute/myroute.controller.js
client/app/myroute/myroute.controller.spec.js
client/app/myroute/myroute.html
client/app/myroute/myroute.scss
Generates a controller.
Example:
yo angular-fullstack:controller user
[?] Where would you like to create this controller? client/app/Produces:
client/app/user/user.controller.js
client/app/user/user.controller.spec.js
Generates a directive.
Example:
yo angular-fullstack:directive myDirective
[?] Where would you like to create this directive? client/app/
[?] Does this directive need an external html file? YesProduces:
client/app/myDirective/myDirective.directive.js
client/app/myDirective/myDirective.directive.spec.js
client/app/myDirective/myDirective.html
client/app/myDirective/myDirective.scss
Simple directive without an html file
Example:
yo angular-fullstack:directive simple
[?] Where would you like to create this directive? client/app/
[?] Does this directive need an external html file? NoProduces:
client/app/simple/simple.directive.js
client/app/simple/simple.directive.spec.js
Generates a filter.
Example:
yo angular-fullstack:filter myFilter
[?] Where would you like to create this filter? client/app/Produces:
client/app/myFilter/myFilter.filter.js
client/app/myFilter/myFilter.filter.spec.js
Generates an AngularJS service.
Example:
yo angular-fullstack:service myService
[?] Where would you like to create this service? client/app/Produces:
client/app/myService/myService.service.js
client/app/myService/myService.service.spec.js
You can also do yo angular-fullstack:factory and yo angular-fullstack:provider for other types of services.
Generates an AngularJS service decorator.
Example:
yo angular-fullstack:decorator serviceName
[?] Where would you like to create this decorator? client/app/Produces
client/app/serviceName/serviceName.decorator.js
###Openshift
Deploying to OpenShift can be done in just a few steps:
yo angular-fullstack:openshift
A live application URL will be available in the output.
oAuth
If you're using any oAuth strategies, you must set environment variables for your selected oAuth. For example, if we're using Facebook oAuth we would do this :
rhc set-env FACEBOOK_ID=id -a my-openshift-app rhc set-env FACEBOOK_SECRET=secret -a my-openshift-appYou will also need to set
DOMAINenvironment variable:rhc set-env DOMAIN=<your-openshift-app-name>.rhcloud.com # or (if you're using it): rhc set-env DOMAIN=<your-custom-domain>After you've set the required environment variables, restart the server:
rhc app-restart -a my-openshift-app
To make your deployment process easier consider using grunt-build-control.
Pushing Updates
grunt
Commit and push the resulting build, located in your dist folder:
grunt buildcontrol:openshift
Deploying to heroku only takes a few steps.
yo angular-fullstack:heroku
To work with your new heroku app using the command line, you will need to run any heroku commands from the dist folder.
If you're using mongoDB you will need to add a database to your app:
heroku addons:create mongolab
Your app should now be live. To view it run heroku open.
If you're using any oAuth strategies, you must set environment variables for your selected oAuth. For example, if we're using Facebook oAuth we would do this :
heroku config:set FACEBOOK_ID=id heroku config:set FACEBOOK_SECRET=secretYou will also need to set
DOMAINenvironment variable:heroku config:set DOMAIN=<your-heroku-app-name>.herokuapp.com # or (if you're using it): heroku config:set DOMAIN=<your-custom-domain>
To make your deployment process easier consider using grunt-build-control.
grunt
Commit and push the resulting build, located in your dist folder:
grunt buildcontrol:heroku
The following packages are always installed by the app generator:
- angular
- angular-cookies
- angular-mocks
- angular-resource
- angular-sanitize
- es5-shim
- font-awesome
- json3
- jquery
- lodash
These packages are installed optionally depending on your configuration:
- angular-route
- angular-ui-router
- angular-socket-io
- angular-bootstrap
- bootstrap
All of these can be updated with bower update as new versions are released.
Yeoman generated projects can be further tweaked according to your needs by modifying project files appropriately.
A .yo-rc file is generated for helping you copy configuration across projects, and to allow you to keep track of your settings. You can change this as you see fit.
Running grunt test will run the client and server unit tests with karma and mocha.
Use grunt test:server to only run server tests.
Use grunt test:client to only run client tests.
Protractor tests
To setup protractor e2e tests, you must first run
npm run update-webdriver
Use grunt test:e2e to have protractor go through tests located in the e2e folder.
Code Coverage
Use grunt test:coverage to run mocha-istanbul and generate code coverage reports.
coverage/server will be populated with e2e and unit folders containing the lcov reports.
The coverage taget has 3 available options:
test:coverage:unitgenerate server unit test coveragetest:coverage:e2egenerate server e2e test coveragetest:coverage:checkcombine the coverage reports and check against predefined thresholds
- when no option is given
test:coverageruns all options in the above order
Debugging
Use grunt serve:debug for a more debugging-friendly environment.
Keeping your app secrets and other sensitive information in source control isn't a good idea. To have grunt launch your app with specific environment variables, add them to the git ignored environment config file: server/config/local.env.js.
Overview
├── client
│ ├── app - All of our app specific components go in here
│ ├── assets - Custom assets: fonts, images, etc…
│ ├── components - Our reusable components, non-specific to to our app
│
├── e2e - Our protractor end to end tests
│
└── server
├── api - Our apps server api
├── auth - For handling authentication with different auth strategies
├── components - Our reusable or app-wide components
├── config - Where we do the bulk of our apps configuration
│ └── local.env.js - Keep our environment variables out of source control
│ └── environment - Configuration specific to the node environment
└── views - Server rendered views
An example client component in client/app
main
├── main.js - Routes
├── main.controller.js - Controller for our main route
├── main.controller.spec.js - Test
├── main.html - View
└── main.less - Styles
An example server component in server/api
thing
├── index.js - Routes
├── thing.controller.js - Controller for our `thing` endpoint
├── thing.model.js - Database model
├── thing.socket.js - Register socket events
└── thing.spec.js - Test
See the contributing docs
This project has 2 main branches: master and canary. The master branch is where the current stable code lives and should be used for production setups. The canary branch is the main development branch, this is where PRs should be submitted to (backport fixes may be applied to master).
By separating the current stable code from the cutting-edge development we hope to provide a stable and efficient workflow for users and developers alike.
When submitting an issue, please follow the guidelines. Especially important is to make sure Yeoman is up-to-date, and providing the command or commands that cause the issue.
When submitting a PR, make sure that the commit messages match the AngularJS conventions.
When submitting a bugfix, try to write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
When submitting a new feature, add tests that cover the feature.
See the travis.yml for configuration required to run tests.
Support us with a monthly donation and help us continue our activities. [Become a backer]
Is your company using Angular-FullStack? Ask your boss to support the project. You will get your logo on our README on Github with a link to your site. [Become a sponsor]