angular-meteor-boilerplate

View the project at http://angular-meteor-boilerplate.meteor.com

Projects using angular-meteor-boilerplate:

This boilerplate is here to give you a starting point for your angular-meteor projects. Essential atmosphere packages are included to give you features like roles and collection schemas out-of-the-box.

Motivation

I really love Meteor for at least seven reasons, and Angular for oh so many more. So why not combine the two with angular-meteor?! angluar-meteor even incorporates both Angular and Blaze so you can slowly migrate to Blaze, or slowly migrate to Angular, or use both together forever ♥.

Installation

Clone the project git clone https://github.com/srtucker22/angular-meteor-boilerplate.git
Go to the primary directory cd angular-meteor-boilerplate
Run meteor to get all the packages meteor
Add a settings.json to the primary directory touch settings.json

Add your personal settings for the following services included in meteor (or remove the ones you don't want)

 {
   "facebook" : {
     "appId": "YOUR_APP_ID",
     "secret": "YOUR_APP_SECRET"
   },
   "kadira": { 
     "appId": "YOUR_APP_ID", 
     "appSecret": "YOUR_APP_SECRET" 
   },
   "papertrail" : {
     "port" : YOUR_PORT_NUMBER
   }
 }

run the app with the settings meteor --settings settings.json
enjoy!
*optional with npm installed, install Yeoman and the generator-angular-meteor packages: npm install -g yo generator-angular-meteor. Read the generator-angular-meteor docs for usage. *note: generator-angular-meteor puts some files in weird places that this boilerplate doesn't agree with, so this still needs tweaking. Stay tuned for future releases!

PS: be sure to also modify ga.js to reflect your google analytics id and domain

Adding allow rules for external URLs

The browser-policy adds rules to deny all operations from external URLs. This helps dealing with clickjacking and other XSS methods used to attack the client. To whitelist a url, add following to server/config/security.js

BrowserPolicy.content.allowOriginForAll(YOUR_URL);

Other security enforcing packages like audit-argument-checks and matteodem:easy-security have also been added.

Structure

Packages Used

Meteor Core
- meteor-platform
Angular
- urigo:angular
- angularui:angular-ui-router
Collections
- aldeed:collection2
- dburles:collection-helpers
Accounts
UI and UX
Security
Development
Monitoring
- meteorhacks:kadira
- wylio:winston-papertrail

The "insecure" and "autopublish" packages are removed by default (they make your app vulnerable).

Folder structure

client/                # Client folder
    config/            # Configuration files (on the client)
  lib/                 # Library files that get executed first
    scripts/           # Javascript files including app.js and modernizr
    styles/            # clutch css files -- normalize.css
  scripts/             # all the angular scripts except app.js
    app.routes.js      # ui-router config
    controllers/       # Contains all controllers
    directives/        # Contains all directives
    services/          # Contains all services/factories
  styles/              # Contains all custom styles
  views/               # Contains all views (html tempalates)
    modules/           # templates for directives and small modules
  index.html           # main html page
lib/                   # Library files that get executed first
  models/              # Model files, for each Meteor.Collection
private/               # Private files
public/                # Public files
  assets/              # Image assets
  ga.js                # google analytics setup
server/                # Server folder
  config/              # Configuration files (on the server)
  lib/                 # Server side library folder
  publications/        # Collection publications
  startup/             # On server startup
.gitignore             # add to this gitignore for ignoring
bower.json             # add to this bower file or use bower install
*settings.json*        # Meteor.settings file -- you need to add this file (touch settings.json)

To Do

clean up user subscription stuff
test spiderable
add more google analytics
SEO packages
CLI Generator tweaks
Animations
Whatever else the people want

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.

isabella232 / angular-meteor-boilerplate Goto Github PK