Skip to content

Commit 2ba4df5

Browse files
Readme update
1 parent 5d84ba6 commit 2ba4df5

File tree

1 file changed

+49
-13
lines changed

1 file changed

+49
-13
lines changed

README.md

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,63 @@
1-
### Mongoose sample
1+
# NestJS Authentication
22

3-
### Installation
43

4+
![Prettier](https://img.shields.io/badge/Code%20style-prettier-informational?logo=prettier&logoColor=white)
5+
[![GPL v3 License](https://img.shields.io/badge/License-GPLv3-green.svg)](./LICENSE)
6+
[![HitCount](https://hits.dwyl.com/anilahir/nestjs-authentication-and-authorization.svg)](https://hits.dwyl.com/anilahir/nestjs-authentication-and-authorization)
57

6-
`npm install`
8+
## Description
79

8-
### Running
10+
NestJS Authentication with JwtService using Bcrypt @nestjs/jwt
911

10-
This example requires docker or a local mongodb installation. If using a local mongodb, see `app.module.ts` for connection options, and make sure there are matching options for the mongodb installation and the source code.
12+
## Features
1113

12-
#### Docker
14+
1. Register
15+
2. Login
16+
3. Unit test
1317

14-
There is a `docker-compose.yml` file for starting Docker.
18+
## Technologies stack:
1519

16-
`docker-compose up`
20+
- JwtService @nestjs/jwt
21+
- Bcrypt
22+
- mongoose
1723

18-
After running the sample, you can stop the Docker container with
24+
## Setup
1925

20-
`docker-compose down`
26+
### 1. Install the required dependencies
2127

22-
### Run the sample
28+
```bash
29+
$ npm install
30+
```
2331

24-
Then, run Nest as usual:
32+
### 2. Rename the .env.example filename to .env and set your local variables
2533

26-
`npm run start`
34+
```bash
35+
$ mv .env.example .env
36+
```
2737

38+
### 3. Start the application
39+
40+
```bash
41+
# development
42+
$ npm run start
43+
44+
# watch mode
45+
$ npm run start:dev
46+
47+
# production mode
48+
$ npm run start:prod
49+
```
50+
51+
## Author
52+
53+
👤 **Vinod**
54+
55+
- Github: [@vinodnextcoder](https://github.com/vinodnextcoder)
56+
57+
## Show your support
58+
59+
Give a ⭐️ if this project helped you!
60+
61+
## License
62+
63+
Release under the terms of [MIT](./LICENSE)

0 commit comments

Comments
 (0)