Skip to content

Commit 823425f

Browse files
author
Luke Marsh
committed
updating docs
1 parent b006655 commit 823425f

File tree

16 files changed

+33
-256
lines changed

16 files changed

+33
-256
lines changed

docs/general/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ efficient tooling and cleanest project structure.
1212
- [**CLI Commands**](commands.md)
1313
- [Tool Configuration](files.md)
1414
- [Server Configurations](server-configs.md)
15-
- [Deployment](deployment.md) *(currently Heroku specific)*
1615
- [FAQ](faq.md)
1716
- [Gotchas](gotchas.md)
1817

docs/general/deployment.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/general/faq.md

Lines changed: 2 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ In development mode CSS sourcemaps require that styling is loaded by blob://,
6262
resulting in browsers resolving font files relative to the main document.
6363
6464
A way to use local webfonts in development mode is to add an absolute
65-
output.publicPath in webpack.dev.babel.js, with protocol.
65+
output.publicPath in webpack.dev.js, with protocol.
6666
6767
```javascript
68-
// webpack.dev.babel.js
68+
// webpack.dev.js
6969
7070
output: {
7171
publicPath: 'http://127.0.0.1:3000/',
@@ -135,57 +135,6 @@ export default [
135135
];
136136
```
137137
138-
## Using this boilerplate with WebStorm
139-
140-
WebStorm is a powerful IDE, and why not also use it as debugger tool? Here is the steps
141-
142-
1. [Install JetBrain Chrome Extension](https://chrome.google.com/webstore/detail/jetbrains-ide-support/hmhgeddbohgjknpmjagkdomcpobmllji)
143-
2. [Setting up the PORT](https://www.jetbrains.com/help/webstorm/2016.1/using-jetbrains-chrome-extension.html)
144-
3. Change WebPack devtool config to `source-map` [(This line)](https://github.com/mxstbr/react-boilerplate/blob/56eb5a0ec4aa691169ef427f3a0122fde5a5aa24/internals/webpack/webpack.dev.babel.js#L65)
145-
4. Run web server (`npm run start`)
146-
5. Create Run Configuration (Run > Edit Configurations)
147-
6. Add new `JavaScript Debug`
148-
7. Setting up URL
149-
8. Start Debug (Click the green bug button)
150-
9. Edit Run Configuration Again
151-
10. Mapping Url as below picture
152-
* Map your `root` directory with `webpack://.` (please note the last dot)
153-
* Map your `build` directory with your root path (e.g. `http://localhost:3000`)
154-
11. Hit OK and restart debugging session
155-
156-
![How to debug using WebStorm](webstorm-debug.png)
157-
158-
### Troubleshooting
159-
160-
1. You miss the last `.` (dot) in `webpack://.`
161-
2. The port debugger is listening tool and the JetBrain extension is mismatch.
162-
163-
### Enable ESLint
164-
165-
ESLint help making all developer follow the same coding format. Please also setting up in your IDE, otherwise, you will fail ESLint test.
166-
1. Go to WebStorm Preference
167-
2. Search for `ESLint`
168-
3. Click `Enable`
169-
170-
![Setting up ESLint](webstorm-eslint.png)
171-
172-
## Use CI with bitbucket pipelines
173-
174-
Your project is on bitbucket? Take advantage of the pipelines feature (Continuous Integration) by creating a 'bitbucket-pipelines.yml' file at the root of the project and use the following code to automatically test your app at each commit:
175-
176-
```YAML
177-
image: gwhansscheuren/bitbucket-pipelines-node-chrome-firefox
178-
179-
pipelines:
180-
default:
181-
- step:
182-
script:
183-
- node --version
184-
- npm --version
185-
- npm install
186-
- npm test
187-
```
188-
189138
## I'm using Node v0.12 and the server doesn't work?
190139
191140
We settled on supporting the last three major Node.js versions for the boilerplate – at the moment

docs/general/files.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,8 @@ they do.
1111

1212
* `.gitignore`: Tells `git` to ignore certain files and folders which don't need to be version controlled, like the build folder.
1313

14-
* `.travis.yml` and `appveyor.yml`: Continuous Integration configuration<br/>
15-
This boilerplate uses [Travis CI](https://travis-ci.com) for Linux environments
16-
and [AppVeyor](https://www.appveyor.com/) for Windows platforms, but feel free
14+
* `.travis.yml`: Continuous Integration configuration<br/>
15+
This boilerplate uses [Travis CI](https://travis-ci.com) for Linux environments, but feel free
1716
to swap either out for your own choice of CI.
1817

1918
* `package.json`: Our `npm` configuration file has three functions:

docs/general/webstorm-debug.png

-443 KB
Binary file not shown.

docs/general/webstorm-eslint.png

-112 KB
Binary file not shown.

docs/js/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ add new parts of your application!
2323
- [ImmutableJS](immutablejs.md)
2424
- [reselect](reselect.md)
2525
- [redux-saga](redux-saga.md)
26-
- [react-intl](i18n.md)
2726
- [routing](routing.md)
2827

2928
## Architecture: `components` and `containers`

docs/js/i18n.md

Lines changed: 0 additions & 105 deletions
This file was deleted.

docs/js/redux-saga.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,3 @@ getComponent(nextState, cb) {
7171
```
7272

7373
Now add as many sagas to your `sagas.js` file as you want!
74-
75-
---
76-
77-
_Don't like this feature? [Click here](remove.md)_

docs/js/remove.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)