React boilerplate integrated with react-scripts, redux, redux-thunk, reselect, sugar, gridle and more...
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.docker
.resources
.storybook
public
scripts
src
ssr
.editorconfig
.eslintignore
.eslintrc
.gitignore
.node-version
.prettierignore
.prettierrc
.stylelintrc
LICENSE.txt
README.md
config-overrides.js
db.json
jsconfig.json
package-lock.json
package.json
yarn.lock

README.md

Coffeekraken React Boilerplate

Coffeekraken React Boilerplate

React boilerplate integrated with react-scripts, redux, redux-thunk, reselect, sugar, gridle and more...



Features

Table of content

  1. Go to website
  2. Install
  3. Get Started
  4. Scripts
  5. Browsers support
  6. Code formatting
  7. Code linting
  8. Contribute
  9. Who are Coffeekraken?
  10. Licence

Install

npm install

If needed, install npm.

Get Started

Run this command to start working as quickly as possible

npm start

Scripts

  • npm run scss : Build the scss files in the src folder
  • npm start : Build/monitor src files using coffeekraken-scripts-stack, start the http server as well as the browsersync one
  • npm start-react : Start the react-scripts process that will build and serve the dev application
  • npm run build : Build the react prod application using the react-scripts CLI
  • npm run build:server : Start the prod server to serve the build folder
  • npm run build:ssr : Start the SSR server. A build has to be done before
  • npm run build:favicon : Generate the favicons from the src/assets/favicon.png file
  • npm run build:favicon:inject : Inject the favicon code inside the build/index.html file
  • npm run eject : Eject the configs from react-scripts
  • npm run browsersync : Start the browsersync service on port 8080
  • npm run storybook : Start the storybook service on port 9009
  • npm run test : Run the tests
  • npm run pretty-quick : Run prettier on the entire project
  • npm run pretty-quick-commit : Run prettier on staged filed
  • npm run lint : Run the linters
  • npm run lint:js : Run the Js linter
  • npm run lint:css : Run the css linter
  • npm run messages:extract : Extract the messages from all the messages.js files up to the translations folder
  • npm run samples:remove : Remove the samples data, containers, etc... to let you start with a clean boilerplate

## Browsers support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
IE11+ last 2 versions last 2 versions last 2 versions

As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

Code formatting

Your code will automatically be formatted using Prettier when you commmit your files.

Code linting

This boilerplate uses some code linting rules. Here's the list:

  1. ESLint with airbnb, react-app, prettier and prettier/react for javascript files
  2. Stylelint with stylelint-config-standard for scss files

Your commits will not been accepted if the code style is not respected!

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...