Skip to content

Commit 7fa0c38

Browse files
coryhousecoryhouse
authored
Merge pull request coryhouse#9 from kunstlicht/master
Improved README rendering on GitHub
2 parents cba65d5 + e33394d commit 7fa0c38

File tree

1 file changed

+33
-30
lines changed

1 file changed

+33
-30
lines changed

‎README.md‎

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
#JavaScript Development Environment
1+
# JavaScript Development Environment
22

33
This is a generic JavaScript development environment that I build from scratch in ["Building a JavaScript Development Environment" on Pluralsight](https://app.pluralsight.com/library/courses/javascript-development-environment/table-of-contents). This isn't tied to any specific JS framework.
44

55
## Get Started
6+
67
1. **Install [Node 6](https://nodejs.org)**. Need to run multiple versions of Node? Use [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows)
78
2. **Clone this repository.** - `git clone https://github.com/coryhouse/javascript-development-environment.git` or [download the zip](https://github.com/coryhouse/javascript-development-environment/archive/master.zip)
89
3. **Make sure you're in the directory you just created.** - `cd javascript-development-environment`
@@ -12,39 +13,41 @@ This will run the automated build process, start up a webserver, and open the ap
1213
6. Having issues? See below.
1314

1415
## Having Issues? Try these things first:
16+
1517
1. Run `npm install` - If you forget to do this, you'll see this: `babel-node: command not found`.
1618
2. Make sure you're running the latest version of Node. Or, use [Node 6.9.1](https://nodejs.org/en/download/releases/) if you're having issues on Windows. Node 7 has issues on some Windows machines.
1719
3. Make sure files with names that begin with a dot (.babelrc, .editorconfig, .eslintrc) are copied to the project directory root. This is easy to overlook if you copy this repository manually.
1820
4. Don't run the project from a symbolic link. It will cause issues with file watches.
1921
5. Having linting issues? Delete any .eslintrc that you're storing in your user directory. Also, disable any ESLint plugin / custom rules that you've enabled within your editor. These will conflict with the ESLint rules defined in the course.
2022
6. Nothing above work? Delete your node_modules folder and re-run npm install.
2123

22-
###Development Dependencies
23-
| **Dependency** | **Use** |
24-
|----------|-------|
25-
|babel-cli|Babel Command line interface |
26-
|babel-core|Babel Core for transpiling the new JavaScript to old |
27-
|babel-loader|Adds Babel support to Webpack |
28-
|babel-preset-latest|Babel preset for running all the latest standardized JavaScript features|
29-
|babel-register|Register Babel to transpile our Mocha tests|
30-
|cheerio|Supports querying DOM with jQuery like syntax - Useful in testing and build process for HTML manipulation|
31-
|cross-env|Cross-environment friendly way to handle environment variables|
32-
|css-loader|Add CSS support to Webpack|
33-
|eslint|Lints JavaScript |
34-
|eslint-plugin-import|Advanced linting of ES6 imports|
35-
|eslint-watch|Add watch functionality to ESLint |
36-
|eventsource-polyfill|Polyfill to support hot reloading in IE|
37-
|expect|Assertion library for use with Mocha|
38-
|express|Serves development and production builds|
39-
|extract-text-webpack-plugin| Extracts CSS into separate file for production build |
40-
|file-loader| Adds file loading support to Webpack |
41-
|jsdom|In-memory DOM for testing|
42-
|mocha| JavaScript testing library |
43-
|npm-run-all| Display results of multiple commands on single command line |
44-
|open|Open app in default browser|
45-
|rimraf|Delete files |
46-
|style-loader| Add Style support to Webpack |
47-
|url-loader| Add url loading support to Webpack |
48-
|webpack| Bundler with plugin system and integrated development server |
49-
|webpack-dev-middleware| Adds middleware support to webpack |
50-
|webpack-hot-middleware| Adds hot reloading to webpack |
24+
### Development Dependencies
25+
26+
| **Dependency** | **Use** |
27+
| --------------------------- | --------------------------------------------------------------------------------------------------------- |
28+
| babel-cli | Babel Command line interface |
29+
| babel-core | Babel Core for transpiling the new JavaScript to old |
30+
| babel-loader | Adds Babel support to Webpack |
31+
| babel-preset-latest | Babel preset for running all the latest standardized JavaScript features |
32+
| babel-register | Register Babel to transpile our Mocha tests |
33+
| cheerio | Supports querying DOM with jQuery like syntax - Useful in testing and build process for HTML manipulation |
34+
| cross-env | Cross-environment friendly way to handle environment variables |
35+
| css-loader | Add CSS support to Webpack |
36+
| eslint | Lints JavaScript |
37+
| eslint-plugin-import | Advanced linting of ES6 imports |
38+
| eslint-watch | Add watch functionality to ESLint |
39+
| eventsource-polyfill | Polyfill to support hot reloading in IE |
40+
| expect | Assertion library for use with Mocha |
41+
| express | Serves development and production builds |
42+
| extract-text-webpack-plugin | Extracts CSS into separate file for production build |
43+
| file-loader | Adds file loading support to Webpack |
44+
| jsdom | In-memory DOM for testing |
45+
| mocha | JavaScript testing library |
46+
| npm-run-all | Display results of multiple commands on single command line |
47+
| open | Open app in default browser |
48+
| rimraf | Delete files |
49+
| style-loader | Add Style support to Webpack |
50+
| url-loader | Add url loading support to Webpack |
51+
| webpack | Bundler with plugin system and integrated development server |
52+
| webpack-dev-middleware | Adds middleware support to webpack |
53+
| webpack-hot-middleware | Adds hot reloading to webpack |

0 commit comments

Comments
 (0)