🚚 Boilerplate for your perfect front-end environment (utilizing Webpack, React, and more)
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
client
docs
flow-typed
internals
.babelrc
.eslintignore
.eslintrc
.flowconfig
.gitignore
LICENSE.md
README.md
config.json
package.json
yarn.lock

README.md

kickup-react

Greenkeeper: Enabled Coverage Status

Why another boilerplate?

We at Kreativgebiet/Fintory aim to move fast and always on the bleeding-edge of technology. That's why we created our own boilerplate. Of course, we started with the boilerplate from TJ and continued from where he left. Since we always want to used bleeding-edge, we needed to have the ability to quickly adapt the boilerplate to our latest needs. That's, why kickup-react is here.

What's in there?

Module Name What is it for?
:atom: React Well, I think you know what this is for
⚑️ Redux State management in React. Done right.
πŸ”© Webpack Compilation of React and all other modules
πŸ’‰ Babel Using ES6 things in ES5 browsers right now
πŸ–Œ aphrodite Excellent CSS-in-JS framework
✨ Flow Type checker for ES6 and javascript
πŸ› eslint Linting the Javascript-code
πŸ› Jest Unit-testing the code
πŸ’₯ CircleCI Automate deployments and integration tasks

How to set it up?

If you also want to use the kickup-react boilerplate, you can simply git clone the repository or download the zip file into your project folder and unzip it. If you are aiming to use this boilerplate, I assume that you are already familiar how to clone it into your development folder.

Note: Be sure to change the README, package.json, etc. since there are some information about Kreativgebiet and the creators of this boilerplate.

Development Setup

Basically all you need to do is run the following command into the freshly cloned folder, since webpack and npm is handling all that development stuff for you:

npm start

Note: Or if you prefer yarn instead of npm, just use yarn start.

Production Setup

Production-use is as easy as development setup. Again, only one simple command is needed for webpack to compile the whole application. A deployment process isn't included yet, but is planned, since we are always searching for the latest awesome and easiest deployment strategy (Remember -> Bleeding-edge).

npm run build # or yarn build

License

Copyright 2016-2017 Kreativgebiet GmbH

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.