Skip to content

Commit 89f19a4

Browse files
Merge pull request #9 from sirdarthvader/dev-fix-security-vulnerability
Updated Readme File
2 parents 7e41c66 + 721045c commit 89f19a4

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

Readme.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,36 @@
1+
[![N|Solid](https://raw.githubusercontent.com/webpack/media/master/logo/icon-square-small.jpg)](https://webpack.js.org/)
2+
3+
### webpack react starter project
4+
5+
[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)
6+
7+
This project is a complete React project, built without using our favourite Create-React-App CLI. All the files and folder have been manually setup to understand under the hood behaviour of webpack.
8+
9+
To use this project, follow the below mentioned simple steps.
10+
11+
- Start by Forking the Repo
12+
- Clone it locally
13+
- Install all dependency
14+
115
## Available Scripts
216

317
### `npm install`
418

5-
In the project directory, you can run:
19+
This will install latest set of packages which the overall project depends on.
620

721
### `npm start`
822

9-
Runs the app in the development mode.<br>
23+
Runs the app in the development mode.
1024

11-
The page will reload if you make edits.<br>
12-
You will also see any lint errors in the console.
25+
The page will reload if you make edits.
26+
If there are any lint errors, they would be printed in the command line as well as the browser consoole while you are in developmet mode
1327

1428
### `npm build`
1529

16-
Builds the app for production to the `dist` folder.<br>
30+
Last but not the least, this command will, build the app for production to the `dist` folder.
1731
It correctly bundles React in production mode and optimizes the build for the best performance.
32+
33+
## Contributions
34+
35+
While using the project if you feel somethings not right or if there is a scope to improve, feel free to create your own branch, do the changes and rasie a pull request.
36+
If you have any other question please get in touch with me using my social links mentioned in my profile.

0 commit comments

Comments
 (0)