Skip to content

Commit 7b53d5a

Browse files
committed
doc(readme): add usage instructions
1 parent a488810 commit 7b53d5a

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,56 @@
44
A Vue project template with Loopback framework featuring ES6, Gulp, and Mocha for unit tests
55

66
> This template is Vue 2.x **only**.
7+
8+
## Folder structure
9+
10+
1. `client`: Vue client files
11+
2. `common`: Common client and server model files
12+
3. `server`: Loopback server files
13+
4. `test`: Unit and E2E test files
14+
15+
## Installation
16+
17+
```
18+
$ npm install
19+
```
20+
21+
## Linting
22+
23+
```
24+
$ npm run lint
25+
```
26+
27+
## Testing
28+
29+
```
30+
$ npm test
31+
```
32+
33+
## Running the development server (API and Client)
34+
35+
```
36+
$ npm run dev
37+
```
38+
39+
## Build to ./build
40+
41+
```
42+
$ npm run build
43+
```
44+
45+
## Executing built files
46+
47+
For client you can use any http server, like [http-server](https://github.com/indexzero/http-server):
48+
49+
```bash
50+
$ cd build/client
51+
$ http-server
52+
```
53+
54+
You can run the server with:
55+
56+
```bash
57+
$ cd build/server
58+
$ node .
59+
```

0 commit comments

Comments
 (0)