Feature:Implemented User Model and Authentication Routes (Login & Register) with Zod Validation

[ManpreetSingh18]

Related Issue(s)

• Fixes #89

Description

This pull request aims to implement user authentication for our backend project, including user register and LogIn functionalities. The implementation includes creating a User model, setting up authentication routes, and using Zod for input validation.

Key Features:

• User Model creation using Mongoose
• User register and Login routes with input validation
• Password hashing with bcrypt
• JWT-based authentication

Changes Made

• Created user-model model in `models' with fields for username, email, and password, including necessary validations.

• Added environment variables for JWT secret and bcrypt salt rounds.

• Implemented Register route (POST /api/auth/register) in routes/auth-router.js:

  • Validate input using Zod.
  • Hashes passwords with bcrypt.
  • Creates a new user in the database.
  • Returns a success message or error response.

• Implemented Login route (POST /api/auth/login) in routes/auth-router.js:

  • Authenticates user credentials like email and password.
  • Returns a JWT token on successful authentication or an error response.

• Implemented Zod in following folder

  • Created Middleware for validation in middleware/validate-middleware.js
  • Zod validation in folder validators/auth-validator.js

• Implemented Login and register in controllers/auth-controller.js

• Define routes in routes/auth-router.js

Screenshots (if applicable)

• Functionality has been tested through Postman as shown in below video

https://github.com/oxiton-foundation/click-metrics/assets/72294811/57b1b0ee-9d75-4a2e-8f26-bbf24eaae1ae

When user with same email already exist

N/A

Checklist

• [x] Code follows the project's style and conventions.
• [x] Code has been tested thoroughly, and all tests pass successfully.
• [x] Documentation has been updated to reflect any relevant changes.
• [x] All new and modified code is adequately commented for clarity.
• [x] Pull request title follows the specified format: [Feature/Enhancement/Bug Fix]: Brief description of the change.

[github-actions[bot]]

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our #24. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

[ManpreetSingh18]

@Swarnendu0123 can you please review this PR?

[Swarnendu0123]

I have mentioned it multiple times that we are going to use firebase for authentication. We don't need this.

[ManpreetSingh18]

@Swarnendu0123 I mentioned it before getting it assigned and you assigned it after my message stating the same Mongo db is mentioned in issue and also in the issue itself mongo db is mentioned . Additionally, the documentation includes MongoDB as well.

[Swarnendu0123]

We will be using mongodb but not for the authentication. We will be using mongodb to store generated links and qrs. We will not store mongodb to store users.

[ManpreetSingh18]

@Swarnendu0123 ok, I will use Firebase. Now I am supposed to do everything mentioned in issue but in Firebase please check the video. You want that type of work in Firebase. Please confirm same?

[Swarnendu0123]

I am planning to use the authentication service provided by firebase in this.

[ManpreetSingh18]

@Swarnendu0123 Here is the updated version of the code

https://github.com/oxiton-foundation/click-metrics/assets/72294811/848bd419-bd70-4cd0-95ee-c31101ffa4ac

[ManpreetSingh18]

Please review and label this PR @Swarnendu0123 .

[ManpreetSingh18]

@Swarnendu0123 any update???

[Swarnendu0123]

Btw you are trying to implement server side firebase authentication. But firebase is actually designed such a way, that we can use it directly on the client. So we are trying to implement it on the client side.

[ManpreetSingh18]

I agree with you but according to #189 opened there, it is mentioned explicitly to use it this way. So I have done it according to the issue. @Swarnendu0123

[Swarnendu0123]

Unfortunately, our development process doesn't allow us to have firebase on the server side.

[ManpreetSingh18]

@Swarnendu0123 Could you please clarify the details of issue #189? Multiple changes have been made due to a communication gap, and a clear and in depth description would help resolve it effectively for frontend am I supposed to use tailwind CSS?

[Swarnendu0123]

@Swarnendu0123 Could you please clarify the details of issue #189? Multiple changes have been made due to a communication gap

I have clearly mentioned to use firebase for authentication. But I don't want to see a large change in a single PR. If you want to integrate firebase in click matrics, first implement the auth. Then the database using mongodb. Now the firebase is made for the client side not the server side. So use it in the client side. Use MongoDB in server side.

for frontend am I supposed to use tailwind CSS?

We are already using tailwind, you should continue with that only!

[Swarnendu0123]

Also don't tag maintainers multiple times. We understand and respect your contribution in our community, but you don't need to mention any maintainers. We will see and respond by ourselves.