PLH is a university league for hackathons. We hope to encourage greater participation in hackathons from universities across the country and foster a rich ecosystem of hackathons. Feel free to fork the code, make improvements, and open pull requests.
The site is based on the MEAN stack and Angular-Fullstack. It uses MongoDB, Node.js, Express, and AngularJS.
- Node.js - Download and Install Node.js. You can also follow this gist for a quick and easy way to install Node.js and npm
- MongoDB - Download and Install MongoDB - Make sure it's running on the default port (27017).
-
Yeoman - Install Yeoman with npm:
$ npm install -g yoYeoman comes with Grunt (the JavaScript task runner) and Bower (the web package manager).
-
Generator-Angular-Fullstack - Install with:
$ npm install -g generator-angular-fullstack
To start working on PLH, first fork the repo then clone it.
Install dependencies:
$ npm install && bower install
Use Grunt to start the server:
$ grunt serve
During install some of you may encounter some issues, most of this issues can be solved by one of the following tips.
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
Updating Grunt:
$ npm update -g grunt-cli
Updating Bower:
$ npm update -g bower
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.
NPM Clean Cache:
$ npm cache clean
Bower Clean Cache:
$ bower cache clean
All configuration is specified in the lib/config folder, particularly the 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.
There are three environments provided by default, development, test, and production.
To run with a different environment, just specify NODE_ENV as you call grunt:
$ NODE_ENV=test grunt serve
NOTE: Running Node.js applications in the production environment enables caching, which is disabled by default in all other environments.
Before you start make sure you have heroku toolbelt and Generator-Angular-Fullstack insalled. To deploy follow these steps:
-
yo angular-fullstack:deploy heroku -
cd heroku && git push heroku master -
heroku addons:add mongohq
That's it! Your app should be live and shareable. Type heroku open to view it.
After app modifications run:
grunt heroku
then commit and push the heroku folder.
Coming soon...
Any questions? Open an issue or message @TimFogarty.
(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.