Skip to content

Commit 7d5b18a

Browse files
Update README.md
1 parent 708be31 commit 7d5b18a

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Authentication Flow uses `json web tokens` via Passport library - `passport-jwt`
5050

5151
## ✨ How to use the code
5252

53-
> **Step 1** - Clone the project
53+
> 👉 **Step 1** - Clone the project
5454
5555
```bash
5656
$ git clone https://github.com/app-generator/api-server-nodejs.git
@@ -59,7 +59,7 @@ $ cd api-server-nodejs
5959

6060
<br />
6161

62-
> **Step 2** - Install dependencies via `Yarn`
62+
> 👉 **Step 2** - Install dependencies via `Yarn`
6363
6464
```bash
6565
$ npm i
@@ -69,7 +69,7 @@ $ yarn
6969

7070
<br />
7171

72-
> **Step 3** - Run the SQLite migration via TypeORM
72+
> 👉 **Step 3** - Run the SQLite migration via TypeORM
7373
7474
```
7575
$ npm run typeorm migration:run
@@ -79,7 +79,7 @@ $ yarn typeorm migration:run
7979

8080
<br />
8181

82-
> **Step 5** - Edit the `.env` using the template `.env.sample`.
82+
> 👉 **Step 4** - Edit the `.env` using the template `.env.sample`.
8383
8484
```env
8585
PORT=5000 # API PORT
@@ -93,7 +93,7 @@ GITHUB_OAUTH_CLIENT_SECRET= ... # Github OAuth secret
9393

9494
<br />
9595

96-
> **Step 4** - Start the API server (development mode)
96+
> 👉 **Step 5** - Start the API server (development mode)
9797
9898
```bash
9999
$ npm run dev
@@ -103,15 +103,15 @@ $ yarn dev
103103

104104
<br />
105105

106-
> **Step 5** - Production Build (files generated in `build` directory)
106+
> 👉 **Step 6** - Production Build (files generated in `build` directory)
107107
108108
```bash
109109
$ yarn build
110110
```
111111

112112
<br />
113113

114-
> **Step 6** - Start the API server for production (files served from `build/index.js`)
114+
> 👉 **Step 7** - Start the API server for production (files served from `build/index.js`)
115115
116116
```bash
117117
$ yarn start
@@ -157,13 +157,13 @@ The SQLite Path is set in `.env`, as `SQLITE_PATH`
157157

158158
## ✨ Database migration
159159

160-
> Generate migration:
160+
> 👉 Generate migration:
161161
162162
```bash
163163
$ yarn typeorm migration:generate -n your_migration_name
164164
```
165165

166-
> Run migration:
166+
> 👉 Run migration:
167167
168168
```bash
169169
$ yarn typeorm migration:run
@@ -175,7 +175,7 @@ $ yarn typeorm migration:run
175175

176176
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)
177177

178-
> **Register** - `api/users/register`
178+
> 👉 **Register** - `api/users/register`
179179
180180
```
181181
POST api/users/register
@@ -190,7 +190,7 @@ Content-Type: application/json
190190

191191
<br />
192192

193-
> **Login** - `api/users/login`
193+
> 👉 **Login** - `api/users/login`
194194
195195
```
196196
POST /api/users/login
@@ -204,7 +204,7 @@ Content-Type: application/json
204204

205205
<br />
206206

207-
> **Logout** - `api/users/logout`
207+
> 👉 **Logout** - `api/users/logout`
208208
209209
```
210210
POST api/users/logout
@@ -220,11 +220,13 @@ authorization: JWT_TOKEN (returned by Login request)
220220

221221
## ✨ Update role for existing user
222222

223-
Using npm:
223+
> 👉 Using npm:
224224
225225
```npm run update-role [user_id] [role_id (optional)]```
226226

227-
Using yarn:
227+
<br />
228+
229+
> 👉 Using yarn:
228230
229231
```npm run update-role [user_id] [role_id (optional)]```
230232

0 commit comments

Comments
 (0)