Slush Jspm-React-seed

Vaseline driven browser side boiler-plate annihilation. Period

Goodies working Out-of-the-box

    NEW! Added working ESlint out-of-the-box

    NEW! Codeclimate ready
    
    NEW! Added floating notifications using toastr
    
    NEW! Livereload using lite-server which is based in BrowserSync.
    
    NEW! Firebase 3.0 friendly, just login with your account and deploy
    
    Added 7 to 1 for managing styles 
    https://github.com/HugoGiraudel/sass-boilerplate
    
    Added React-bootstrap (ausence of css feel)
    
    Jspm for universal multi-purpose Javascript package managing

    Babel for transpiling & React for templating

    Nodejs modules (>= 200000 modules available)

    ES6 & ES7 Syntactic Sugar ready out-of-the-box

    Minimum possible configuration, maximum features,
    judge by yourself

    Bundling & Minifying (JSPM native)

    Transpiling at runtime on browser side (BABEL native)

    Static Node server run in local Production/Dev mode (JSPM native)

    No Grunt/Gulp/Broccoli/Cake/Whatever... needed (at the time of writing, 
    let's see if we can build the whole seed without them (challenge accepted)

Getting Started

Install slush-jspm-react-seed globally:

$ npm install -g slush-jspm-react-seed

Usage

1. Create a new folder for your project:

$ mkdir my-slush-jspm-react-seed

2. Run the generator from within the new folder and download deps after:

$ cd my-slush-jspm-react-seed && slush jspm-react-seed
$ jspm i

3. Execute 'install_global_dependencies' in your resulting root folder

Npm commands

Disable dependencies cache, unbundle and unminify js files , scss2css:

$ npm run dev

Enable dependencies cache, bundle and minify, scss2css:

$ npm run prod

Run server

$ npm start

Run ESlint

$ npm run eslint

Deploy in Firebase (you have to login via command line in your OWN account):

$ firebase deploy

Common Pitfalls

Don't forget install jspm dependencies after installing using jspm i

If your connection is terribly slow then jspm i may have hiccups while doing look ups, just repeat few times until he manages to download all dependencies

While using the seed with you preferred CI you may see this error:

     Updating registry cache...
     Looking up github:twbs/bootstrap
     Downloading github:twbs/bootstrap@3.3.1

err  Error downloading github:twbs/bootstrap

     GitHub rate limit reached. To increase the limit use GitHub authentication.
     Run jspm endpoint config github to set this up.

warn Installation changes not saved.

Fear not, here you can see how to overcome the problem, unfortunately the seed can't do that for you: https://github.com/jspm/jspm-cli/blob/master/docs/registries.md

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Copyright (c) 2015, Sergio Lopez

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.