mean-company

Demo

NOTE: replace all 'http' with 'https' if using 'https' (set in config.json)

• Website
• Continuous Integration
  • This automatically deploys and tests the yeoman generated mean-seed website on each Github push (from local development)
• Test Coverage Reports (currently ~90% frontend coverage, ~60% backend coverage)
  • Node API/Integration Test Coverage
  • Angular Karma Unit Test Coverage
• Backend API Interactive Docs
  • i.e. Auth API
• Github Repo with Generated Code

Learn to Code with MEAN Stack

Walkthrough course to use this Generator and MEAN stack in general

Quick Start

NOTE: If you want to CLONE this EXISTING repository, see cloning.md instead. Otherwise, if you want to build a NEW mean-seed from scratch using the Yeoman Generator, follow these steps below.

1. machine (global / program) installs (if you don't have them already)
   1. install git, nodejs, mongodb, phantomjs
   2. sudo npm install -g grunt-cli yo bower generator-mean-seed yuidocjs forever less
2. yo mean-seed (from the NEW directory you want to create the app in)
   1. npm install && bower install (if not already run successfully by Yeoman or any time package.json or bower.json change)
      1. If any bower issues (sometimes 1 or more packages will timeout), just re-run bower update && bower install
      2. If any npm issues, run npm cache clean (and optionally delete the troublesome package folders from the node_modules folder) then re-run npm install
   2. ./node_modules/protractor/bin/webdriver-manager update (if not already run successfully by Yeoman)
   3. grunt q to build assets (if not already run successfully by Yeoman and any time a *.less (or *.scss) or *.html file changes)
3. start server and view app
   1. node run.js to start node server (make sure MongoDB is already running first)
   2. open a browser to http://localhost:3000/ (or https://localhost:3000/ if using https) to view the site/app
4. run tests
   1. grunt
5. (optional) Git remote (should have already been init'ed and commit'ed automatically)
   1. (optional) add a remote: git remote add origin [url to repository]

Setup + Running (Longer Version)

• see setup-detailed.md and running.md in the docs folder

Generators

Make sure to leverage the available (sub)generators - i.e. for creating new pages/routes/controllers, directives, and services! Run generators with yo mean-seed and then select the sub-generator you want to use!

https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/docs/generators/modules.md

Updating

You CAN and SHOULD keep your project up to date with the core (seed) generator you used as it goes through version upgrades. Just re-run:

Ensure the generator is up to date:

npm install -g generator-mean-seed

Pull in updates to your project (core/seed - make sure to select the same core you used originally):

yo mean-seed

More Info

• see the docs folder for more documentation. Each (sub)folder typically has an overview.md file - start there. Some key docs (roughly in order of priority) listed below:
  • overview.md
  • setup-running folder
    • overview.md
  • tools-dependencies folder
  • files folder
  • testing-automation folder
  • frontend-angular/common-actions.md
  • backend-node/common-actions.md

MEAN (Mongo Express Angular Node) seed

• Built using Mean-Seed: https://github.com/jackrabbitsgroup/generator-mean-seed
  • see here for more details - technology used, dependencies, limitations/compatibility, code standards, directory/file structure, workflow, etc.
• MongoDB, Express.js, AngularJS, Node.js + Yeoman (Grunt, Bower, Yo) + Jasmine, Karma, Protractor