-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
0 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,115 +4,4 @@ Backbone Tooltip is an AMD module for use within RequireJS projects. | |
|
|
||
| ## Prerequisites | ||
| * Backbone Tooltip is designed to be loaded using RequireJS - Download [Require.js](http://requirejs.org/) and set up an AMD application. [Quick start guide](http://requirejs.org/docs/start.html) | ||
| * | ||
|
|
||
| ## 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. | ||
|
|
||
| ## Quick Install | ||
|
|
||
| The quickest way to get started with MEAN is to clone the project and utilize it like this: | ||
|
|
||
| Install dependencies: | ||
|
|
||
| $ npm install | ||
|
|
||
| Export the node Path to load your lib into project (default in HEROKU) | ||
| $ export NODE_PATH=lib | ||
|
|
||
| We recommend using [Grunt](https://github.com/gruntjs/grunt-cli) to start the server: | ||
| $ grunt | ||
|
|
||
| When not using grunt you can use: | ||
|
|
||
| $ node server | ||
|
|
||
| Then open a browser and go to: | ||
|
|
||
| http://localhost:3000 | ||
|
|
||
| ## Quick Deployment | ||
| 4 commands to deploy your mean app to heroku, | ||
| 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 | ||
| ``` | ||
|
|
||
| ## Configuration | ||
| All configuration is specified in the [config](config/) folder, particularly the [config.js](config/config.js) file. 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. | ||
| * root - This is determined automatically at the start of this file, but can be overridden here. | ||
| * 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 Registration - Facebook, GitHub, Google, Twitter. You can specify your own social accounts here for each social platform, with the following for each provider: | ||
| * clientID | ||
| * clientSecret | ||
| * callbackURL | ||
|
|
||
| To run with a different environment, just specify NODE_ENV as you call grunt: | ||
|
|
||
| $ 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. | ||
|
|
||
| ## MEAN Modules | ||
| Mean presents a growing eco-system of MEAN based modules in the npm repository, To write (and contribute) your own MEAN based module checkout [mean-logger](https://npmjs.org/package/mean-logger) for examples. | ||
|
|
||
| ## More Information | ||
|
|
||
| * Contact Amos Haviv on any issue via [E-Mail](mailto:[email protected]), [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. | ||
|
|
||
| ## Credits | ||
| Inspired by the great work of [Madhusudhan Srinivasa](https://github.com/madhums/) | ||
|
|
||
| ## License | ||
|
|
||
| (The MIT License) | ||
|
|
||
| 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. | ||