-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from sirdarthvader/dev-fix-security-vulnerability
Updated Readme File
- Loading branch information
Showing
1 changed file
with
24 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,36 @@ | ||
[![N|Solid](https://raw.githubusercontent.com/webpack/media/master/logo/icon-square-small.jpg)](https://webpack.js.org/) | ||
|
||
### webpack react starter project | ||
|
||
[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger) | ||
|
||
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. | ||
|
||
To use this project, follow the below mentioned simple steps. | ||
|
||
- Start by Forking the Repo | ||
- Clone it locally | ||
- Install all dependency | ||
|
||
## Available Scripts | ||
|
||
### `npm install` | ||
|
||
In the project directory, you can run: | ||
This will install latest set of packages which the overall project depends on. | ||
|
||
### `npm start` | ||
|
||
Runs the app in the development mode.<br> | ||
Runs the app in the development mode. | ||
|
||
The page will reload if you make edits.<br> | ||
You will also see any lint errors in the console. | ||
The page will reload if you make edits. | ||
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 | ||
|
||
### `npm build` | ||
|
||
Builds the app for production to the `dist` folder.<br> | ||
Last but not the least, this command will, build the app for production to the `dist` folder. | ||
It correctly bundles React in production mode and optimizes the build for the best performance. | ||
|
||
## Contributions | ||
|
||
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. | ||
If you have any other question please get in touch with me using my social links mentioned in my profile. |