Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leolanese/nodejs_jwt_authentification_api
Building JWT Authentication API With NodeJS and MondogDB using Cluster
https://github.com/leolanese/nodejs_jwt_authentification_api
javascript jwt mongodb mongoose nodejs
Last synced: 2 days ago
JSON representation
Building JWT Authentication API With NodeJS and MondogDB using Cluster
- Host: GitHub
- URL: https://github.com/leolanese/nodejs_jwt_authentification_api
- Owner: leolanese
- Created: 2023-06-15T10:11:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-09T12:34:21.000Z (9 months ago)
- Last Synced: 2024-02-09T13:55:41.624Z (9 months ago)
- Topics: javascript, jwt, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage:
- Size: 316 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NodeJS JWT Authentication API
> Building JWT Authentication API With NodeJS and MondogDB using Cluster
This codebase is essentially creating a Node.js-based REST API for user registration and login. The key concepts involved are JWT (JSON Web Tokens) and MongoDB, used for data persistence.
## A brief overview:
- User Registration: The user provides their name, email, and password to register for an account. When the request is sent to the /user endpoint, the application first checks if a user with the provided email already exists in the MongoDB database. If not, the password is hashed for security reasons, and then the new user's data is stored in the database. Finally, a JWT is generated using the user's unique identifier (id), which can be used for authenticating future requests.
- User Login: The user provides their email and password to log in. When the request is sent to the /login endpoint, the application first finds the user in the MongoDB database by email. Then, it compares the provided password with the hashed password stored in the database using bcrypt. If they match, it means the password is correct. Finally, a JWT is generated for the user, similar to the registration process.
- JWT: JSON Web Tokens (JWTs) are a standard for securely transmitting information between parties as a JSON object. They are used here to handle user sessions. After a user logs in or registers, they receive a JWT. For subsequent requests that need authentication, the user sends this token in the headers. The server can then verify this token and allow the user to access protected routes.
- MongoDB Cluster: MongoDB, a NoSQL document database, is being used to persist user data. In this codebase, the MongoDB Atlas Cluster is being used, which is a fully-managed cloud database provided by MongoDB. It's scalable and allows you to distribute your data across multiple servers for high availability and performance.
This API is built following the MVC (Model-View-Controller) pattern and uses the Express.js framework for routing and middleware. It also uses the mongoose package to interact with MongoDB and enforce the data schema, and bcryptjs for hashing passwords. The jsonwebtoken package is used for creating JWTs and express-async-handler for handling asynchronous route handlers.
---
## Let's start the project
```js
// we need start creating the `package.json`
npm init
```
```js
npm i express bcryptjs express-async-handler jsonwebtoken mongoose morgan
```
```js
npm i -D nodemon
```
---
## Setup environment
Let's create a new file `.env` and `.gitignore`
```js
// .env
PORT = 5050
MODE = development
```
```js
// .gitignore
.env
**/node_modules
```
---
## Update type in package.json
> "type": "module" in your package.json file, which instructs Node.js to treat .js files as ES Modules
> In brief: Replace `require` (CommonJS style) with `import` (ESM Style) from now on
```js
...
"type": "module",
...
```
---
## Connecting to the MongoDb server Cluster
We need Node.js server to rung successfully on port 5050 and it also connected to MongoDB successfully. Just to mention, for simplicity MVC pattern will be in place
## Running server
```js
npm run dev
...
[nodemon] starting `node server.js`
Server running on: 5050
MongoDB is Connected successfully: ac-okc09tz-shard-00-01.ooedapl.mongodb.net
```
---
## Testing API Requests/Responses
### Test POST (invalid)
### Test POST (valid register)
### Test POST (invalid register)
### Test POST (login success after valid register)
### Test GET (login into private router successfully after register)
> TIP: We need to add Headers: `Key`: `Authorization` & `Value`: ``
---
### :100: Thanks!
#### Now, don't be an stranger. Let's stay in touch!
##### :radio_button: linkedin: @LeoLanese
##### :radio_button: Twitter: @LeoLanese
##### :radio_button: Portfolio: www.leolanese.com
##### :radio_button: DEV.to: dev.to/leolanese
##### :radio_button: Blog: leolanese.com/blog
##### :radio_button: Questions / Suggestion / Recommendation: [email protected]