Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sabarasaba/modern-backbone-starterkit
Lightweight starting point for a modern backbone web app.
https://github.com/sabarasaba/modern-backbone-starterkit
babel backbone boilerplate javascript modern
Last synced: 5 days ago
JSON representation
Lightweight starting point for a modern backbone web app.
- Host: GitHub
- URL: https://github.com/sabarasaba/modern-backbone-starterkit
- Owner: sabarasaba
- Created: 2015-03-11T13:50:14.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-22T19:19:51.000Z (almost 7 years ago)
- Last Synced: 2024-04-08T09:04:35.627Z (9 months ago)
- Topics: babel, backbone, boilerplate, javascript, modern
- Language: JavaScript
- Size: 237 KB
- Stars: 188
- Watchers: 11
- Forks: 43
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Modern Backbone Starter-kit
[](https://gitter.im/sabarasaba/modern-backbone-starterkit)
This project provides a prepared development environment for modern backbone
development. ES6, Jest, HMR, css-next, eslint; all ready for you to use.
### Getting Started
Just [clone](github-windows://openRepo/https://github.com/sabarasaba/modern-backbone-starterkit) or [fork](https://github.com/sabarasaba/modern-backbone-starterkit/fork) the repo and start hacking:
```shell
$ git clone https://github.com/sabarasaba/modern-backbone-starterkit.git AwesomeApp && cd $_
$ yarn install
$ cp .env.example .env
```
### Development
Uses webpack-dev-server with HMR to serve your app:
```shell
$ yarn dev
```
### Note on css
This project uses postcss with a few plugins in order to provide a modern approach
to dealing with css. It runs autoprefixer by default, supports nested classes,
imports and everything else that [css-next](http://cssnext.io/) has to offer.
### Production build
This will build a minified version of the app and will output everything into
the `public/` folder:
```shell
$ yarn build
```
If you wanna serve the production app you can do so by running:
```shell
$ yarn start
```
### How to run tests
You can easily run the unit tests by doing:
```shell
$ yarn test
```
Or check your code coverage with:
```shell
$ yarn coverage
```
### Linter
Currently using airbnb's presets, you can run it with:
```shell
$ yarn lint
```
### How to Update
You can always fetch and merge the recent changes from this repo back into
your own project:
```shell
$ git checkout master
$ git fetch upstream
$ git merge upstream/master
$ npm install
```
### A Note on ES Classes
ES2015 Classes do *not* work well with Backbone or Marionette at time of writing. See https://github.com/jashkenas/backbone/issues/3560. Use Backbone's built in extend functions to get around this for the time being.
### Learn More
* [jQuery](https://jquery.com/)
* [Lodash](https://lodash.com/)
* [Handlebars](http://handlebarsjs.com/)
* [Backbone.js](http://backbonejs.org/)
* [Marionette.js](http://marionettejs.com/)
* [Jest](https://facebook.github.io/jest/)
* [Webpack](https://webpack.js.org/)
* [Babel](https://babeljs.io/)
* [css-next](http://cssnext.io/)
* [eslint](http://eslint.org/)
### Support
Have feedback, feature request or need help? Create an issue !
## License
The MIT License (MIT)
Copyright (c) 2017 [Ignacio Rivas](https://github.com/sabarasaba)
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.