Skip to content
This repository was archived by the owner on Sep 6, 2022. It is now read-only.

Commit f4b13c6

Browse files
authored
Doc updates (#2372)
* Fix VS Code debugging instructions + spelling/grammar * Moar spelling * Capitalz * Created a section for RBP forks to clean up the electron stuff and add gretzky's SSR repo
1 parent d1c4520 commit f4b13c6

File tree

5 files changed

+35
-28
lines changed

5 files changed

+35
-28
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on something that might not end up being merged into the project.
1010
Before opening a pull request, please ensure:
1111

1212
- [ ] You have followed our [**contributing guidelines**](https://github.com/react-boilerplate/react-boilerplate/blob/master/CONTRIBUTING.md)
13-
- [ ] double-check your branch is based on `dev` and targets `dev`
13+
- [ ] Double-check your branch is based on `dev` and targets `dev`
1414
- [ ] Pull request has tests (we are going for 100% coverage!)
1515
- [ ] Code is well-commented, linted and follows project conventions
1616
- [ ] Documentation is updated (if necessary)

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
- [routing](js/routing.md)
3535
- [Maintenance](maintenance)
3636
- [Dependency Update](maintenance/dependency.md)
37-
- [Convert React Boilerplate To Electron App](electron)
37+
- [Forks](forks)
3838

3939
## Overview
4040

docs/electron/README.md

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

docs/forks/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Forks
2+
3+
## Electron
4+
5+
Electron is a very popular open source library developed by GitHub. It enables the creation of cross-platform desktop applications using HTML, CSS and Javascript. This fork provide steps through which you can kickstart an Electron application using `react-boilerplate`.
6+
7+
Electron provides a combined single runtime of Chromium and Node.js. No server is needed to host your React application. You can simply package the entire source code in a `.exe`, `.dmg` or `.deb` file.
8+
9+
This fork gives you two options:
10+
11+
1. Clone the repository for a fresh start: [reactron](https://github.com/mjangir/reactron)
12+
13+
2. Read the steps to [convert an existing RBP-based project to an Electron application](https://github.com/mjangir/reactron/wiki/Convert-Existing-To-Electron)
14+
15+
## Server-side rendering
16+
17+
This repo receives many requests for server-side rendering and there have been plenty of long discussions on the topic. None have led to an implementation that we're happy to merge into the main repo. That being said, @gretzky has a fork which you can use as a solid starting point for your SSR needs: [react-boilerplate-ssr](https://github.com/gretzky/react-boilerplate-ssr)

docs/general/debugging.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Debugging
22

3-
## Table of Contents
4-
5-
- [Debugging with VC Code](#debugging-with-vscode)
6-
- [Debugging with WebStorm](#debugging-with-webStorm)
3+
- [Debugging with Visual Studio Code](#debugging-with-visual-studio-code)
4+
- [Debugging with WebStorm](#debugging-with-webstorm)
75
- [Troubleshooting](#troubleshooting)
86
- [Enable ESLint](#enable-eslint)
97

108
## Debugging with Visual Studio Code
119

12-
You can super charge your React debugging workflow with VS Code and Chrome debugging by using this `launch.json` config:
10+
You can super charge your React debugging workflow via VS Code and Chrome. Here are the steps:
11+
12+
1. Install the [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) extension in VS Code.
13+
2. Add the `Launch Chrome` option to your `launch.json` config:
1314

1415
```json
1516
{
@@ -30,13 +31,18 @@ You can super charge your React debugging workflow with VS Code and Chrome debug
3031
}
3132
```
3233

33-
You can read more in [Live edit and debug your React apps directly from VS Code — without leaving the editor 🔥 🎉🎈](https://medium.com/front-end-hacking/live-edit-and-debug-your-react-apps-directly-from-vs-code-without-leaving-the-editor-3da489ed905f)
34+
3. Start your dev server with `npm run start`.
35+
4. Launch the VS Code Debugger with the `Launch Chrome` configuration.
36+
37+
You can then set breakpoints directly from inside VS Code, use stepping with the Chrome or VS Code buttons and more.
3438

35-
**Note**: There's currently a [known problem](https://github.com/react-boilerplate/react-boilerplate/pull/1698) with source maps and VS Code. You can change your webpack config to use `inline-source-map` and the issue should be resolved.
39+
Read all about it in the [Debugger for Chrome page](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome).
40+
41+
**Note**: There's currently a [known problem](https://github.com/react-boilerplate/react-boilerplate/pull/1698) with source maps and VS Code. You can change your Webpack dev config to use `inline-source-map` instead of `eval-source-map` and the issue should be resolved.
3642

3743
## Debugging with WebStorm
3844

39-
WebStorm is a powerful IDE, and why not also use it as debugger tool? Here is the steps
45+
WebStorm is a powerful IDE, and why not also use it as debugger tool? Here are the steps:
4046

4147
1. [Install JetBrain Chrome Extension](https://chrome.google.com/webstore/detail/jetbrains-ide-support/hmhgeddbohgjknpmjagkdomcpobmllji)
4248
2. [Setting up the PORT](https://www.jetbrains.com/help/webstorm/2016.1/using-jetbrains-chrome-extension.html)
@@ -61,16 +67,11 @@ WebStorm is a powerful IDE, and why not also use it as debugger tool? Here is th
6167

6268
### Enable ESLint
6369

64-
ESLint help making all developer follow the same coding format. Please also setting up in your IDE, otherwise, you will fail ESLint test.
70+
ESLint helps developers on a team follow the same coding format. It's highly recommended to set it up in your IDE to avoid failing the linting step in tests.
6571

66-
1. Go to WebStorm Preference
72+
1. Go to WebStorm Preferences
6773
2. Search for `ESLint`
6874
3. Click `Enable`
6975

7076
![Setting up ESLint](webstorm-eslint.png)
7177

72-
## Have another question?
73-
74-
Submit an [issue](https://github.com/react-boilerplate/react-boilerplate/issues),
75-
hop onto the [Gitter channel](https://gitter.im/mxstbr/react-boilerplate)
76-
or contact Max direct on [twitter](https://twitter.com/mxstbr)!

0 commit comments

Comments
 (0)