Skip to content
This repository was archived by the owner on Apr 11, 2019. It is now read-only.

Commit 6c82770

Browse files
authored
Update README.md
1 parent 08f418d commit 6c82770

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Coming soon the app will support Docker, which will contain a configured web ser
4242
## Getting Started
4343
To try the example application out or to use the project, follow the instructions below.
4444

45+
There are two options for installation:
46+
4547
1. **Clone repo**
4648

4749
git clone https://github.com/RyanCCollins/scalable-react-boilerplate.git
@@ -56,6 +58,18 @@ To try the example application out or to use the project, follow the instruction
5658

5759
Your app will be served at: http://0.0.0.0:1337/
5860

61+
or, you can install it using Slush via the npm package
62+
```
63+
npm install -g slush slush-generator-scalable-react
64+
```
65+
66+
cd into the folder where you want to create your project and run:
67+
```
68+
slush generator-scalable-react
69+
```
70+
71+
Follow the onscreen instructions to create your app.
72+
5973
## Deployment
6074
A demo ExpressJS setup is included with the app. The express server will serve up the production minified bundle.js, index.html and any other assets that are located in the `/server/public` folder.
6175

@@ -191,12 +205,11 @@ export {
191205
For information on how to build your own generators with relative ease, please go to the [Plop Microgenerator](https://github.com/amwmedia/plop) homepage for detailed instructions.
192206

193207
## Testing
194-
Included in the setup is a test suite that will run your tests in the browser using Karma. A number of testing utilities are included, including
208+
Included in the setup is a test suite that will run your tests using Jest. A number of testing utilities are included, including
195209
- Expect (Plus Expect-JSX)
196-
- Mocha
197210
- Chai (JSX and Immutable)
198211
- Enzyme
199-
- Karma (including multiple Karma plugins)
212+
- Jest & enzyme-to-json in order to use the Jest snappshotting with Enzyme.
200213

201214
You can see examples for testing of React Components, Redux Action Creators and Reducers in the repository [here](https://github.com/RyanCCollins/scalable-react-boilerplate/tree/master/app/src/containers/FeatureFirstContainer/tests). Please follow the convention of naming tests with a .test.js postfix, or else the test suite will not recognize your tests.
202215

0 commit comments

Comments
 (0)