Skip to content

Commit 571b6f7

Browse files
committed
updated readme
1 parent 4e9a556 commit 571b6f7

2 files changed

Lines changed: 74 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
11
# create-react-webpack
2+
3+
Create React Application with all standard practices, with easy formats known to users, so that users can easily modify the various config files.
4+
5+
## Available Scripts
6+
7+
After creating project directory you can run following scripts:-
8+
9+
### `npm run build`
10+
11+
builds the application for production to the `dist` folder inside directory.<br>
12+
Uses webpack `prod` `config` along with `base` `config`
13+
14+
### `npm run dev`
15+
16+
Start the development server on default port `8080`.<br>
17+
Starts server in hot mode but doesn't preserve state of component if any while reloading.
18+
19+
### `npm run dev:hot`
20+
21+
Start the development server on default port `8080`.<br>
22+
Starts server in hot mode preserves state of component also if any while applying hot load patch.
23+
24+
### `npm test`
25+
26+
Launches Test Runner in the intreactive manner.
27+
28+
### `npm run format`
29+
30+
Enforces the formatting rules defined in `.prettierrc`.<br>
31+
For inforcing your rules `replace` the `file` or `content` of `prettierrc`.
32+
33+
### `npm run lint`
34+
35+
Enforces the linting rules defined in `.eslintrc`.
36+
<br>
37+
For inforcing your rules `replace` the `file` or `content` of `eslintrc`.<br>
38+
Here we are using `prettier` for formatting and `eslint` for enforcing rules related to best coding practices.

template/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
11
# create-react-webpack
2+
3+
This project is bootstraped with [create-react-webpack](https://github.com/AlokTakshak/create-react-webpack).
4+
5+
## Available Scripts
6+
7+
Scripts available inside this project:-
8+
9+
### `npm run build`
10+
11+
builds the application for production to the `dist` folder inside directory.<br>
12+
Uses webpack `prod` `config` along with `base` `config`
13+
14+
### `npm run dev`
15+
16+
Start the development server on default port `8080`.<br>
17+
Starts server in hot mode but doesn't preserve state of component if any while reloading.
18+
19+
### `npm run dev:hot`
20+
21+
Start the development server on default port `8080`.<br>
22+
Starts server in hot mode preserves state of component also if any while applying hot load patch.
23+
24+
### `npm test`
25+
26+
Launches Test Runner in the intreactive manner.
27+
28+
### `npm run format`
29+
30+
Enforces the formatting rules defined in `.prettierrc`.<br>
31+
For inforcing your rules `replace` the `file` or `content` of `prettierrc`.
32+
33+
### `npm run lint`
34+
35+
Enforces the linting rules defined in `.eslintrc`.
36+
<br>
37+
For inforcing your rules `replace` the `file` or `content` of `eslintrc`.<br>
38+
Here we are using `prettier` for formatting and `eslint` for enforcing rules related to best coding practices.

0 commit comments

Comments
 (0)