Skip to content

Commit 0f9e8da

Browse files
committed
docs: add README.md
1 parent a3e0b6e commit 0f9e8da

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

framework-ts/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Framework with TypeScript Example
2+
3+
This example contains [app] and [framework]
4+
5+
## Quick Start
6+
7+
Start an application using custom framework called yadan
8+
9+
```bash
10+
$ cd yadan
11+
$ npm install
12+
$ npm run tsc
13+
$ cd ../app
14+
$ npm install
15+
$ npm run tsc
16+
$ npm run dev
17+
```
18+
19+
Yadan is a framework by TypeScript, it should be published to npm normally. With this example, you need `npm run tsc`.
20+
21+
## Run Test
22+
23+
Application
24+
25+
```bash
26+
$ cd app
27+
$ npm run tsc
28+
$ npm test
29+
```
30+
31+
Framework
32+
33+
```bash
34+
$ cd yadan
35+
$ npm run tsc
36+
$ npm test
37+
```
38+
39+
## Questions & Suggestions
40+
41+
Please open an issue [here](https://github.com/eggjs/egg/issues).
42+
43+
[app]: https://github.com/eggjs/examples/tree/master/framework-ts/app
44+
[framework]: https://github.com/eggjs/examples/tree/master/framework-ts/yadan

0 commit comments

Comments
 (0)