Skip to content

Commit 1827020

Browse files
committed
Update README.md
1 parent a385bc5 commit 1827020

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,28 @@
22

33
Minimal boilerplate for a single-page app using React, TypeScript with JSX support (TSX), and Visual Studio Code.
44

5-
Usage:
5+
## Usage
66

7-
* Install Node.js
7+
Note: Run commands from the root folder of the cloned repository.
8+
9+
To build the project from the command-line:
10+
11+
* Install [Node.js](https://nodejs.org/)
812
* `npm install`
913
* `npm run build`
1014

11-
To view the app:
15+
To view the app in the browser:
1216

1317
* `npm install -g http-server`
1418
* `http-server`
1519
* Open [http://localhost:8080/](http://localhost:8080/) in your browser of choice.
20+
21+
To develop using Visual Studio Code:
22+
23+
* Install [Visual Studio Code](https://code.visualstudio.com/).
24+
* Open the root folder of the cloned repository.
25+
* The `tasks.json` file is configured to run the TypeScript compiler in watch mode. Press Cmd+Shift+B on Mac or Ctrl+Shift+B on Windows or Linux to start the watcher.
26+
27+
To instantly view changes in the browser while developing:
28+
29+
* Run `npm run dev` in a terminal. This will start both `webpack` in watch mode and `http-server`. Hint: Visual Studio Code contains a built-in terminal.

0 commit comments

Comments
 (0)