Skip to content

Commit e671b10

Browse files
Update README.md
1 parent e02d417 commit e671b10

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,44 +45,44 @@ Authentication Flow uses [json web tokens](https://jwt.io) via Passport library
4545

4646
## How to use the code
4747

48-
**Clone the sources**
48+
**Step #1** - Clone the project
4949

5050
```bash
5151
$ git clone https://github.com/app-generator/api-server-nodejs.git
5252
$ cd api-server-nodejs
5353
```
5454

55-
**Install dependencies** via NPM or Yarn
55+
**Step #2** - Install dependencies via NPM or Yarn
5656

5757
```bash
5858
$ npm i
5959
// OR
6060
$ yarn
6161
```
6262

63-
**Run the SQLite migration**
63+
**Step #3** - Run the SQLite migration via TypeORM
6464

6565
```
6666
$ yarn typeorm migration:run
6767
```
6868

69-
**Start the API server** - development mode
69+
**Step #4** - Start the API server (development mode)
7070

7171
```bash
7272
$ npm dev
7373
// OR
7474
$ yarn dev
7575
```
7676

77-
**Production Build** - files generated in `build` directory
77+
**Step #5** - Production Build (files generated in `build` directory)
7878

7979
```bash
8080
$ npm build
8181
// OR
8282
$ yarn build
8383
```
8484

85-
**Start the API server** - for production (files served from `build/index.js`)
85+
**Step #6** - Start the API server for production (files served from `build/index.js`)
8686

8787
```bash
8888
$ npm start

0 commit comments

Comments
 (0)