Moving to MEAN.JS

Author: amoshaviv

.bowerrc

@@ -1,8 +1,8 @@
 {
-  "directory": "public/lib",
-  "storage": {
-          "packages": ".bower-cache",
-          "registry": ".bower-registry"
-  },
-  "tmp": ".bower-tmp"
+	"directory": "public/lib",
+	"storage": {
+		"packages": ".bower-cache",
+		"registry": ".bower-registry"
+	},
+	"tmp": ".bower-tmp"
 }

.gitignore

@@ -1,8 +1,9 @@
 .DS_Store
 .nodemonignore
 .sass-cache/
-.bower-*/
-.idea/
+npm-debug.log
 node_modules/
 public/lib
-test/coverage/
+app/tests/coverage/
+.bower-*/
+.idea/

.jshintrc

@@ -13,12 +13,13 @@
     "quotmark": "single", // Define quotes to string values.
     "regexp": true, // Prohibit `.` and `[^...]` in regular expressions.
     "undef": true, // Require all non-global variables be declared before they are used.
-    "unused": true, // Warn unused variables.
+    "unused": false, // Warn unused variables.
     "strict": true, // Require `use strict` pragma in every file.
     "trailing": true, // Prohibit trailing whitespaces.
     "smarttabs": false, // Suppresses warnings about mixed tabs and spaces
     "globals": { // Globals variables.
-        "angular": true
+        "angular": true,
+        "ApplicationConfiguration": true
     },
     "predef": [ // Extra globals.
         "define",

.slugignore

@@ -1 +1 @@
-/test
+/app/tests

README.md

@@ -1,138 +1,72 @@
-# MEAN Stack
+[![MEAN.JS Logo](http://meanjs.org/img/logo-small.png)](http://meanjs.org/)
 
-MEAN is a boilerplate that provides a nice starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [AngularJS](http://angularjs.org/) based applications. It is designed to give you quick and organized way to start developing of MEAN based web apps with useful modules like mongoose and passport pre-bundled and configured. We mainly try to take care of the connection points between existing popular frameworks and solve common integration problems.  
+MEAN.JS is a full-stack JavaScript open-source solution, which provides a solid starting point for [MongoDB](http://www.mongodb.org/), [Node.js](http://www.nodejs.org/), [Express](http://expressjs.com/), and [AngularJS](http://angularjs.org/) based applications. The idea is to solve the common issues with connecting those frameworks, build a robust framework to support daily development needs, and help developers use better practices while working with popular JavaScript components. 
+
+## Before You Begin 
+Before you begin we recommend you read about the basic building blocks that assemble a MEAN.JS application: 
+* MongoDB - Go through [MongoDB Official Website](http://mongodb.org/) and proceed to their [Official Manual](http://docs.mongodb.org/manual/), which should help you understand NoSQL and MongoDB better.
+* Express - The best way to understand express is through its [Official Website](http://expressjs.com/), particularly [The Express Guide](http://expressjs.com/guide.html); you can also go through this [StackOverflow Thread](http://stackoverflow.com/questions/8144214/learning-express-for-node-js) for more resources.
+* AngularJS - Angular's [Official Website](http://angularjs.org/) is a great starting point. You can also use [Thinkster Popular Guide](http://www.thinkster.io/), and the [Egghead Videos](https://egghead.io/).
+* Node.js - Start by going through [Node.js Official Website](http://nodejs.org/) and this [StackOverflow Thread](http://stackoverflow.com/questions/2353818/how-do-i-get-started-with-node-js), which should get you going with the Node.js platform in no time.
 
-## Prerequisites
-* Node.js - Download and Install [Node.js](http://www.nodejs.org/download/). You can also follow [this gist](https://gist.github.com/isaacs/579814) for a quick and easy way to install Node.js and npm
-* MongoDB - Download and Install [MongoDB](http://www.mongodb.org/downloads) - Make sure it's running on the default port (27017).
 
-### Tools Prerequisites
-* NPM - Node.js package manager, should be installed when you install node.js.
-* Bower - Web package manager, installing [Bower](http://bower.io/) is simple when you have npm:
+## Prerequisites
+Make sure you have installed all these prerequisites on your development machine.
+* Node.js - [Download & Install Node.js](http://www.nodejs.org/download/) and the npm package manager, if you encounter any problems, you can also use this [Github Gist](https://gist.github.com/isaacs/579814) to install Node.js.
+* MongoDB - [Download & Install MongoDB](http://www.mongodb.org/downloads), and make sure it's running on the default port (27017).
+* Bower - You're going to use the [Bower Package Manager](http://bower.io/) to manage your front-end packages, in order to install it make sure you've installed Node.js and npm, then install bower globally using npm:
 
 ```
 $ npm install -g bower
 ```
 
-### Optional
-* Grunt - Download and Install [Grunt](http://gruntjs.com).
+* Grunt - You're going to use the [Grunt Task Runner](http://gruntjs.com/) to automate your development process, in order to install it make sure you've installed Node.js and npm, then install grunt globally using npm:
 
-## Additional Packages
-* Express - Defined as npm module in the [package.json](package.json) file.
-* Mongoose - Defined as npm module in the [package.json](package.json) file.
-* Passport - Defined as npm module in the [package.json](package.json) file.
-* AngularJS - Defined as bower module in the [bower.json](bower.json) file.
-* Twitter Bootstrap - Defined as bower module in the [bower.json](bower.json) file.
-* UI Bootstrap - Defined as bower module in the [bower.json](bower.json) file.
+```
+$ sudo npm install -g grunt-cli
+```
 
 ## Quick Install
-  The quickest way to get started with MEAN is to clone the project and utilize it like this:
-
-  Install dependencies:
-
-    $ npm install
-
-  We recommend using [Grunt](https://github.com/gruntjs/grunt-cli) to start the server:
+Once you've installed all the prerequisites, you're just a few steps away from starting to develop you MEAN application.
 
-    $ grunt
-    
-  When not using grunt you can use:
+The first thing you should do is install the Node.js dependencies. The boilerplate comes pre-bundled with a package.json file that contains the list of modules you need to start your application, to learn more about the modules installed visit the NPM & Package.json section.
 
-    $ node server
-    
-  Then open a browser and go to:
+To install Node.js dependencies you're going to use npm again, in the application folder run this in the command-line:
 
-    http://localhost:3000
-
-
-## Troubleshooting
-During install some of you may encounter some issues, most of this issues can be solved by one of the following tips.
-If you went through all this and still can't solve the issue, feel free to contact me(Amos), via the repository issue tracker or the links provided below.
-
-#### Update NPM, Bower or Grunt
-Sometimes you may find there is a weird error during install like npm's *Error: ENOENT*, usually updating those tools to the latest version solves the issue.
-
-Updating NPM:
 ```
-$ npm update -g npm
+$ npm install
 ```
 
-Updating Grunt:
-```
-$ npm update -g grunt-cli
-```
+This command does a few things:
+* First it will install the dependencies needed for the application to run.
+* If you're running in a development environment, it will then also install development dependencies needed for testing and running your application.
+* Finally, when the install process is over, npm will initiate a bower installcommand to install all the front-end modules needed for the application
 
-Updating Bower:
-```
-$ npm update -g bower
-```
-
-#### Cleaning NPM and Bower cache
-NPM and Bower has a caching system for holding packages that you already installed.
-We found that often cleaning the cache solves some troubles this system creates.
+## Running Your Application
+After the install process is over, you'll be able to run your application using Grunt, just run grunt default task:
 
-NPM Clean Cache:
 ```
-$ npm cache clean
-```
-
-Bower Clean Cache:
+$ grunt
 ```
-$ bower cache clean
-```
-
- 
-## Configuration
-All configuration is specified in the [config](config/) folder, particularly the [config.js](config/config.js) file and the [env](config/env/) files. Here you will need to specify your application name, database name, as well as hook up any social app keys if you want integration with Twitter, Facebook, GitHub or Google.
-
-### Environmental Settings
 
-There are three environments provided by default, __development__, __test__, and __production__. Each of these environments has the following configuration options:
-* __db__ - This is the name of the MongoDB database to use, and is set by default to __mean-dev__ for the development environment.
-* __app.name__ - This is the name of your app or website, and can be different for each environment. You can tell which environment you are running by looking at the TITLE attribute that your app generates.
-* __Social OAuth Keys__ - Facebook, GitHub, Google, Twitter. You can specify your own social application keys here for each platform:
-	* __clientID__
-	* __clientSecret__
-	* __callbackURL__
+Your application should run on the 3000 port so in your browser just go to [http://localhost:3000](http://localhost:3000)
+                            
+That's it! your application should be running by now, to proceed with your development check the other sections in this documentation. 
+If you encounter any problem try the Troubleshooting section.
 
-To run with a different environment, just specify NODE_ENV as you call grunt:
+## Getting Started With MEAN.JS
+You have your application running but there are a lot of stuff to understand, we recommend you'll go over the [Offical Documentation](http://meanjs.org/docs.html). 
+In the docs we'll try to explain both general concepts of MEAN components and give you some guidelines to help you improve your development procees. We tried covering as many aspects as possible, and will keep update it by your request, you can also help us develop the documentation better by checking out the *gh-pages* branch of this repository.
 
-	$ NODE_ENV=test grunt
-
-If you are using node instead of grunt, it is very similar:
-
-	$ NODE_ENV=test node server
-
-> NOTE: Running Node.js applications in the __production__ environment enables caching, which is disabled by default in all other environments.
-
-## Getting Started
-  We pre-included an article example, check it out:
-  * [The Model](https://github.com/linnovate/mean/blob/master/app/models/article.js) - Where we define our object schema.
-  * [The Controller](https://github.com/linnovate/mean/blob/master/app/controllers/articles.js) - Where we take care of our backend logic.
-  * [NodeJS Routes](https://github.com/linnovate/mean/blob/master/config/routes.js) - Where we define our REST service routes.
-  * [AngularJs Routes](https://github.com/linnovate/mean/blob/master/public/js/config.js) - Where we define our CRUD routes.
-  * [The AngularJs Service](https://github.com/linnovate/mean/blob/master/public/js/services/articles.js) - Where we connect to our REST service.
-  * [The AngularJs Controller](https://github.com/linnovate/mean/blob/master/public/js/controllers/articles.js) - Where we take care of  our frontend logic.
-  * [The AngularJs Views Folder](https://github.com/linnovate/mean/blob/master/public/views/articles) - Where we keep our CRUD views.
-
-## Heroku Quick Deployment
-Before you start make sure you have <a href="https://toolbelt.heroku.com/">heroku toolbelt</a> installed and an accessible mongo db instance - you can try <a href="http://www.mongohq.com/">mongohq</a> which have an easy setup )
-
-```bash
-git init
-git add .
-git commit -m "initial version"
-heroku apps:create
-git push heroku master
-```
+## Community
+* Use to [Offical Website](http://meanjs.org) to learn about changes and the roadmap.
+* Join #meanjs on freenode.
+* Discuss it in the new [Google Group](https://groups.google.com/d/forum/meanjs)
+* Ping us on [Twitter](http://twitter.com/meanjsorg) and [Facebook](http://facebook.com/meanjs)
 
-## More Information
-  * Contact Amos Haviv on any issue via [E-Mail](mailto:mail@amoshaviv.com), [Facebook](http://www.facebook.com/amoshaviv), or [Twitter](http://www.twitter.com/amoshaviv).
-  * Visit us at [Linnovate.net](http://www.linnovate.net/).
-  * Visit our [Ninja's Zone](http://www.meanleanstartupmachine.com/) for extended support.
+## Live Example
+Browse the live MEAN.JS example on [http://meanjs.herokuapp.com](http://meanjs.herokuapp.com).
 
-## Credits
-Inspired by the great work of [Madhusudhan Srinivasa](https://github.com/madhums/)
 
 ## License
 (The MIT License)

app/controllers/articles.js

@@ -7,19 +7,6 @@ var mongoose = require('mongoose'),
     Article = mongoose.model('Article'),
     _ = require('lodash');
 
-
-/**
- * Find article by id
- */
-exports.article = function(req, res, next, id) {
-    Article.load(id, function(err, article) {
-        if (err) return next(err);
-        if (!article) return next(new Error('Failed to load article ' + id));
-        req.article = article;
-        next();
-    });
-};
-
 /**
  * Create a article
  */
@@ -39,6 +26,13 @@ exports.create = function(req, res) {
     });
 };
 
+/**
+ * Show the current article
+ */
+exports.read = function(req, res) {
+    res.jsonp(req.article);
+};
+
 /**
  * Update a article
  */
@@ -49,9 +43,8 @@ exports.update = function(req, res) {
 
     article.save(function(err) {
         if (err) {
-            return res.send('users/signup', {
-                errors: err.errors,
-                article: article
+            res.render('error', {
+                status: 500
             });
         } else {
             res.jsonp(article);
@@ -62,33 +55,25 @@ exports.update = function(req, res) {
 /**
  * Delete an article
  */
-exports.destroy = function(req, res) {
+exports.delete = function(req, res) {
     var article = req.article;
 
     article.remove(function(err) {
         if (err) {
-            return res.send('users/signup', {
-                errors: err.errors,
-                article: article
+            res.render('error', {
+                status: 500
             });
         } else {
             res.jsonp(article);
         }
     });
 };
 
-/**
- * Show an article
- */
-exports.show = function(req, res) {
-    res.jsonp(req.article);
-};
-
 /**
  * List of Articles
  */
-exports.all = function(req, res) {
-    Article.find().sort('-created').populate('user', 'name username').exec(function(err, articles) {
+exports.list = function(req, res) {
+    Article.find().sort('-created').populate('user', 'displayName').exec(function(err, articles) {
         if (err) {
             res.render('error', {
                 status: 500
@@ -97,4 +82,26 @@ exports.all = function(req, res) {
             res.jsonp(articles);
         }
     });
+};
+
+/**
+ * Article middleware
+ */
+exports.articleByID = function(req, res, next, id) {
+    Article.load(id, function(err, article) {
+        if (err) return next(err);
+        if (!article) return next(new Error('Failed to load article ' + id));
+        req.article = article;
+        next();
+    });
+};
+
+/**
+ * Article authorization middleware
+ */
+exports.hasAuthorization = function(req, res, next) {
+    if (req.article.user.id !== req.user.id) {
+        return res.send(403, 'User is not authorized');
+    }
+    next();
 };