Skip to content

Commit 93cd9ee

Browse files
authored
Update README.md
1 parent 829daf7 commit 93cd9ee

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,42 @@
11
This is a simple nodejs boilerplate application, which uses router-services-model architecture to build the api's.
22

3-
<b>To Run the application in production mode </b> <br />
3+
4+
## Requirements
5+
6+
[NodeJS](http://nodejs.org/en/)
7+
8+
Install global TypeScript and TypeScript Node
9+
10+
```
11+
npm install -g typescript ts-node
12+
```
13+
14+
## Clone this repository
15+
16+
```
17+
git clone git@github.com:lineldcosta/rest-api-boilerplate.git .
18+
```
19+
20+
Then install the dependencies
21+
22+
```
23+
npm install
24+
```
25+
26+
## To Run the application in production mode
27+
28+
```
429
yarn start:prod
30+
```
31+
32+
## To Run the application in development mode
533

6-
<b>To Run the application in development mode </b> <br />
34+
```
735
yarn start:dev
36+
```
37+
38+
## To Run the tests
839

9-
<b>To Run the tests </b> <br />
40+
```
1041
Yarn test
42+
```

0 commit comments

Comments
 (0)