Skip to content

Commit de8a49b

Browse files
Update README.md
1 parent e3a6ce3 commit de8a49b

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,53 +38,63 @@ Authentication Flow uses `json web tokens` via Passport library - `passport-jwt`
3838

3939
<br />
4040

41-
## Requirements
41+
## Requirements
4242

4343
- [Node.js](https://nodejs.org/) >= 12.x
4444
- [SQLite](https://www.sqlite.org/index.html)
4545

4646
<br />
4747

48-
## How to use the code
48+
## How to use the code
4949

50-
**Step #1** - Clone the project
50+
> **Step #1** - Clone the project
5151
5252
```bash
5353
$ git clone https://github.com/app-generator/api-server-nodejs.git
5454
$ cd api-server-nodejs
5555
```
5656

57-
**Step #2** - Install dependencies via NPM or Yarn
57+
<br />
58+
59+
> **Step #2** - Install dependencies via NPM or Yarn
5860
5961
```bash
6062
$ npm i
6163
// OR
6264
$ yarn
6365
```
6466

65-
**Step #3** - Run the SQLite migration via TypeORM
67+
<br />
68+
69+
> **Step #3** - Run the SQLite migration via TypeORM
6670
6771
```
6872
$ yarn typeorm migration:run
6973
```
7074

71-
**Step #4** - Start the API server (development mode)
75+
<br />
76+
77+
> **Step #4** - Start the API server (development mode)
7278
7379
```bash
7480
$ npm dev
7581
// OR
7682
$ yarn dev
7783
```
7884

79-
**Step #5** - Production Build (files generated in `build` directory)
85+
<br />
86+
87+
> **Step #5** - Production Build (files generated in `build` directory)
8088
8189
```bash
8290
$ npm build
8391
// OR
8492
$ yarn build
8593
```
8694

87-
**Step #6** - Start the API server for production (files served from `build/index.js`)
95+
<br />
96+
97+
> **Step #6** - Start the API server for production (files served from `build/index.js`)
8898
8999
```bash
90100
$ npm start
@@ -96,7 +106,7 @@ The API server will start using the `PORT` specified in `.env` file (default 500
96106

97107
<br />
98108

99-
## Codebase Structure
109+
## Codebase Structure
100110

101111
```bash
102112
< ROOT / src >
@@ -116,19 +126,21 @@ The API server will start using the `PORT` specified in `.env` file (default 500
116126
| |-- users.ts # Define Users API Routes
117127
|
118128
|
119-
|-- index.js # API Entry Point
129+
|-- index.js # API Entry Point
120130
|-- .env # Specify the ENV variables
121131
|
122132
|-- ************************************************************************
123133
```
124134

125135
<br />
126136

127-
## SQLite Path
137+
## SQLite Path
128138

129139
The SQLite Path is set in `.env`, as `SQLITE_PATH`
130140

131-
## Database migration
141+
<br />
142+
143+
## ✨ Database migration
132144

133145
> Generate migration:
134146
@@ -144,7 +156,7 @@ $ yarn typeorm migration:run
144156

145157
<br />
146158

147-
## API
159+
## API
148160

149161
For a fast set up, use this POSTMAN file: [api_sample](https://github.com/app-generator/api-server-nodejs-pro/blob/master/media/api.postman_collection.json)
150162

@@ -191,7 +203,7 @@ authorization: JWT_TOKEN (returned by Login request)
191203

192204
<br />
193205

194-
## Credits
206+
## Credits
195207

196208
This software is provided by the core AppSeed team with an inspiration from other great NodeJS starters:
197209

0 commit comments

Comments
 (0)