Skip to content

Commit 905111d

Browse files
committed
doc(readme): improve documentation
1 parent 2cc239e commit 905111d

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

template/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,35 @@
22

33
{{ description }}
44

5+
## Folder structure
6+
7+
1. `client`: Vue client files
8+
2. `common`: Common client and server model files
9+
3. `server`: Loopback server files
10+
4. `test`: Unit and E2E test files
11+
512
## Installation
613

714
```
815
$ npm install
916
```
1017

11-
## Testing
18+
## Linting
1219

1320
```
14-
$ npm test
21+
$ npm run lint
1522
```
1623

17-
## Running Development
24+
## Testing
1825

1926
```
20-
$ npm run dev
27+
$ npm test
2128
```
2229

23-
## Running Production (after build)
30+
## Running Development Server (API and Client)
2431

2532
```
26-
$ npm start
33+
$ npm run dev
2734
```
2835

2936
## Build to ./build

0 commit comments

Comments
 (0)