params.json

{"name":"Tesla.js","tagline":"Boilerplate node.js stack with Express, MongoDB & AngularJS","body":"# Tesla.js\r\n\r\nTesla.js is a boilerplate [Node.js](http://www.nodejs.org/) stack, which includes [Express](http://expressjs.com/), [MongoDB](http://www.mongodb.org/) & [AngularJS](http://angularjs.org/).\r\n\r\n## Prerequisites\r\n* 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\r\n* MongoDB - Download and Install [MongoDB](http://www.mongodb.org/downloads) - Make sure it's running on the default port (27017).\r\n\r\n### Tools Prerequisites\r\n* NPM - Node.js package manager, should be installed when you install node.js.\r\n* Bower - Web package manager, installing [Bower](http://bower.io/) is simple when you have npm:\r\n\r\n```\r\n$ npm install -g bower\r\n```\r\n\r\n### Optional\r\n* Grunt - Download and Install [Grunt](http://gruntjs.com).\r\n\r\n## Additional Packages\r\n#### Defined as npm modules in the [package.json](package.json) file.\r\n* [Express](http://expressjs.com/) - Sinatra inspired web development framework\r\n* [Mongoose](http://mongoosejs.com/) - elegant mongodb object modeling for node.js\r\n* [Passport](http://passportjs.org/) - Simple, unobtrusive authentication for Node.js.\r\n* [Jade](http://jade-lang.com/) - robust, elegant, feature rich template engine for nodejs\r\n* [Stylus](http://learnboost.github.io/stylus/) - Robust, expressive, and feature-rich CSS superset\r\n* [Superagent](https://github.com/visionmedia/superagent) - Elegant & feature rich browser / node HTTP with a fluent API\r\n* [MD5](https://github.com/pvorb/node-md5) - native js function for hashing messages with MD5\r\n\r\n#### Defined as bower modules in the [bower.json](bower.json) file.\r\n* [AngularJS](http://angularjs.org) - HTML enhanced for web apps!\r\n* [Zepto.js](http://zeptojs.com/) - Minimalist JavaScript library for modern browsers, with a jQuery-compatible API\r\n* [jQuery](http://jquery.com/) - jQuery JavaScript Library\r\n\r\n## Quick Install\r\n  The quickest way to get started with Tesla.js is to clone the project and utilize it like this:\r\n\r\n  Install dependencies:\r\n\r\n    $ npm install\r\n\r\n  We recommend using [Grunt](https://github.com/gruntjs/grunt-cli) to start the server:\r\n\r\n    $ grunt\r\n\r\n  When not using grunt you can use:\r\n\r\n    $ node server\r\n\r\n  Then open a browser and go to:\r\n\r\n    http://localhost:3000\r\n\r\n\r\n## Troubleshooting\r\nDuring install some of you may encounter some issues, most of this issues can be solved by one of the following tips.\r\nIf 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.\r\n\r\n#### Update NPM, Bower or Grunt\r\nSometimes 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.\r\n\r\nUpdating NPM:\r\n```\r\n$ npm update -g npm\r\n```\r\n\r\nUpdating Grunt:\r\n```\r\n$ npm update -g grunt-cli\r\n```\r\n\r\nUpdating Bower:\r\n```\r\n$ npm update -g bower\r\n```\r\n\r\n#### Cleaning NPM and Bower cache\r\nNPM and Bower has a caching system for holding packages that you already installed.\r\nWe found that often cleaning the cache solves some troubles this system creates.\r\n\r\nNPM Clean Cache:\r\n```\r\n$ npm cache clean\r\n```\r\n\r\nBower Clean Cache:\r\n```\r\n$ bower cache clean\r\n```\r\n\r\n\r\n## Configuration\r\nAll 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.\r\n\r\n### Environmental Settings\r\n\r\nThere are three environments provided by default, __development__, __test__, and __production__. Each of these environments has the following configuration options:\r\n* __db__ - This is the name of the MongoDB database to use, and is set by default to __mean-dev__ for the development environment.\r\n* __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.\r\n* __Social OAuth Keys__ - Facebook, GitHub, Google, Twitter. You can specify your own social application keys here for each platform:\r\n\t* __clientID__\r\n\t* __clientSecret__\r\n\t* __callbackURL__\r\n\r\nTo run with a different environment, just specify NODE_ENV as you call grunt:\r\n\r\n\t$ NODE_ENV=test grunt\r\n\r\nIf you are using node instead of grunt, it is very similar:\r\n\r\n\t$ NODE_ENV=test node server\r\n\r\n> NOTE: Running Node.js applications in the __production__ environment enables caching, which is disabled by default in all other environments.\r\n\r\n## Heroku Quick Deployment\r\nBefore 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 )\r\n\r\n```bash\r\ngit init\r\ngit add .\r\ngit commit -m \"initial version\"\r\nheroku apps:create\r\ngit push heroku master\r\n```\r\n\r\n## Credits\r\nBuilt on top of the [MEAN Stack](https://github.com/linnovate/mean) by [Amos Haviv](https://twitter.com/amoshaviv)\r\n\r\n## License\r\n(The MIT License)\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining\r\na copy of this software and associated documentation files (the\r\n'Software'), to deal in the Software without restriction, including\r\nwithout limitation the rights to use, copy, modify, merge, publish,\r\ndistribute, sublicense, and/or sell copies of the Software, and to\r\npermit persons to whom the Software is furnished to do so, subject to\r\nthe following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be\r\nincluded in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\r\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\r\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\r\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\r\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}