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

Commit c17cd13

Browse files
committed
Merge branch 'master' of https://github.com/RyanCCollins/scalable-react-boilerplate into feat_rc_server_rendering
2 parents 6d05934 + 3f27cee commit c17cd13

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
*.scss linguist-language=JavaScript
22
*.html linguist-language=JavaScript
3+
*.css linguist-language=JavaScript

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ Below are a few example apps that have been built with this project
2929
- Corporate Dashboard
3030
- [See the Code](https://github.com/RyanCCollins/corporate-dashboard)
3131
- [See the Live App](https://corporate-dashboard-client.herokuapp.com/)
32+
- Meetup Event Planner
33+
- [See the Code](https://github.com/RyanCCollins/meetup-event-planner)
34+
- [See the Live App](http://meetup-event-planner.herokuapp.com/)
35+
- Udacity Alumni App
36+
- [See the Code](https://github.com/udacityalumni/alumni-client)
37+
- Live App coming soon
3238

3339
## Experimental Features
3440
### Server Rendering
@@ -42,6 +48,8 @@ Coming soon the app will support Docker, which will contain a configured web ser
4248
## Getting Started
4349
To try the example application out or to use the project, follow the instructions below.
4450

51+
There are two options for installation:
52+
4553
1. **Clone repo**
4654

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

5765
Your app will be served at: http://0.0.0.0:1337/
5866

67+
or, you can install it using Slush via the npm package
68+
```
69+
npm install -g slush slush-generator-scalable-react
70+
```
71+
72+
cd into the folder where you want to create your project and run:
73+
```
74+
slush generator-scalable-react
75+
```
76+
77+
Follow the onscreen instructions to create your app.
78+
5979
## Deployment
6080
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.
6181

@@ -191,12 +211,11 @@ export {
191211
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.
192212

193213
## 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
214+
Included in the setup is a test suite that will run your tests using Jest. A number of testing utilities are included, including
195215
- Expect (Plus Expect-JSX)
196-
- Mocha
197216
- Chai (JSX and Immutable)
198217
- Enzyme
199-
- Karma (including multiple Karma plugins)
218+
- Jest & enzyme-to-json in order to use the Jest snappshotting with Enzyme.
200219

201220
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.
202221

@@ -205,7 +224,7 @@ To run tests, you will run
205224
npm run test
206225
```
207226

208-
which will pick up any file with the .test.js postfix and run it through Karma / Mocha, printing a report to the commandline.
227+
which will pick up any file with the .test.js postfix and run it through Jest.
209228

210229

211230
## Technologies / Libraries

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
"extract-text-webpack-plugin": "^v2.0.0-beta.3",
9696
"file-loader": "^0.9.0",
9797
"foundation-sites": "^6.2.3",
98-
"grommet-udacity": "v0.1.1",
98+
"grommet-udacity": "v0.1.10",
9999
"history": "^1.14.0",
100100
"html-webpack-plugin": "^2.7.1",
101101
"immutable": "^3.7.5",

0 commit comments

Comments
 (0)