Vaettir React-Redux Boiler

Boilerplate React+Redux template using create-react-app storybook, bitrc, Bulma and a few other great dev resources and libraries.

This boiler is in it's earliest stages, and while it may make the process of getting your react app started, the intended features are TBD.

Installation

Clone this repo to wherever you clone your repos to
Rename the App to your project name
Navigate into the project directory
Run yarn (or npm install alternatively)
Run yarn test to make sure things went well
Start the React App by running yarn start
Start the Storybook by running yarn run storybook (optional)

git clone https://github.com/SkothaSec/Vaettir-React-Redux-Boiler.git

mv Vaettir-React-Redux-Boiler MyAppsName && cd MyAppsName

yarn

yarn test

yarn start

yarn run storybook

From here the react app template should automatically render in your browser (on port 3000), if your ran Storybook, that will render as well (on port 9009)

Usage example

When you ran yarn to install the dependencies from package.json the project structure will basically look like so:

my-app
├── README.md
├── node_modules
├── package.json
├── yarn.lock
├── .gitignore
├── .bit
├── .bitmap
├── bit.json
├── .storybook
├──/public
│   ├── favicon.ico
│   ├── index.html
│   ├── manifest.json
│   ├──/font                //Storybook related directory
│   ├──/icon                //Storybook related directory
│   └──/images
│       └── readMeBanner.png
└── src
    ├── index.js
    ├── App.css
    ├── App.js
    ├── testsducks
    ├── App.test.js
    ├── logo.svg
    ├── serviceWorker.js
    ├──/ducks
    ├──/stories             //Storybook related directory
    │   └──index.js
    ├──/components
    │   ├── App.js
    │   ├──/tests
    │   │   └──App.test.js
    │   ├──/layout
    │   │    ├──Layout.js
    │   │    └──/tests
    │   │       └──Layout.test.js
    │   └──/styles
    │       ├──App.css
    │       ├──layoutComponents.css
    │       ├──index.css
    │       └──logo.svg
    └──/services
        └──/api

For more information and usage, please refer to the Wiki.

Development setup

There was some issues getting the proper dependencies with webpack and babel due to a known issue with Storybook, which should be resolved given the package.json setup. For now run yarn and yarn test and if they show any errors roll with those.

If you feel so inclined: Submit an issue to the project

yarn
yarn test
yarn start

Release History

0.1.0
- The first proper release
- CHANGE: Base template created
0.0.1
- Work in progress

Contributing

Fork it (https://github.com/skothasec/Vaettir-React-Redux-Boiler/fork)
Create your feature branch (git checkout -b feature/fooBar)
Commit your changes (git commit -am 'Add some fooBar')
Push to the branch (git push origin feature/fooBar)
Create a new Pull Request

Credits

This README template is based on of Dan Bader's README Template`.

SkothaSec/Vaettir-React-Redux-Boiler