A progressive Node.js framework for building efficient and scalable server-side applications.
\n
\n\n\n\n\n\n\n\n\n \n \n \n
\n \n\n## Description\n\n[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.\n\n## Project setup\n\n```bash\n$ npm install\n```\n\n## Compile and run the project\n\n```bash\n# development\n$ npm run start\n\n# watch mode\n$ npm run start:dev\n\n# production mode\n$ npm run start:prod\n```\n\n## Run tests\n\n```bash\n# unit tests\n$ npm run test\n\n# e2e tests\n$ npm run test:e2e\n\n# test coverage\n$ npm run test:cov\n```\n\n## Deployment\n\nWhen you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.\n\nIf you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:\n\n```bash\n$ npm install -g mau\n$ mau deploy\n```\n\nWith Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.\n\n## Resources\n\nCheck out a few resources that may come in handy when working with NestJS:\n\n- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.\n- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).\n- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).\n- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.\n- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).\n- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).\n- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).\n- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).\n\n## Support\n\nNest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).\n\n## Stay in touch\n\n- Author - [Kamil MyΕliwiec](https://twitter.com/kammysliwiec)\n- Website - [https://nestjs.com](https://nestjs.com/)\n- Twitter - [@nestframework](https://twitter.com/nestframework)\n\n## License\n\nNest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).\n\n\n\nπ Auth Module for NestJS\n\nThis AuthModule provides π§βπ» user authentication features for your NestJS ποΈ application, including:\n\nπ User registration\n\nπ Login with username and password\n\nπ₯ Role-based login\n\nπ² OTP-based login using Twilio\n\nπ‘οΈ JWT token generation and protection for routes\n\nβ¨ Features\n\nπ User Registration\n\nπ Login with Credentials\n\nπ₯ Role-Based Login\n\nπ² Send OTP for Login\n\nβ Verify OTP for Login\n\nπ‘οΈ Protected Routes with JWT Guard\n\nβοΈ Installation\n\nClone the ποΈ repository and navigate to the project directory:\n\ngit clone \ncd \n\nInstall π¦ dependencies:\n\nnpm install\n\nSet up ποΈ environment variables. Create a .env file in the root of your project and include the following:\n\nJWT_SECRET=your-jwt-secret\nTWILIO_ACCOUNT_SID=your-twilio-account-sid\nTWILIO_AUTH_TOKEN=your-twilio-auth-token\nTWILIO_PHONE_NUMBER=your-twilio-phone-number\n\nRun the πββοΈ project:\n\nnpm run start:dev\n\nποΈ Folder Structure\n\n\nsrc/\nβββ auth/\nβ βββ dto/\nβ β βββ auth.dto.ts # DTOs for requests\nβ βββ guards/\nβ β βββ jwt.guard.ts # JWT authentication guard\nβ βββ auth.controller.ts # Handles HTTP requests\nβ βββ auth.module.ts # Module definition\nβ βββ auth.service.ts # Business logic for authentication\nβββ prisma/\nβ βββ prisma.service.ts # Prisma service for database operations\n\n\n\n\nπ§ Usage\n\nπ Endpoints\n\n1. π Register\n\nπ URL: POST /auth/register\n\nπ Description: Registers a new user.\n\nπ€ Request Body:\n\n{\n \"email\": \"user@example.com\",\n \"password\": \"password123\",\n \"name\": \"John Doe\",\n \"role\": \"user\"\n}\n\nπ₯ Response:\n\n{\n \"user\": {\n \"id\": \"123\",\n \"email\": \"user@example.com\",\n \"name\": \"John Doe\"\n },\n \"token\": \"jwt-token\"\n}\n\n2. π Login\n\nπ URL: POST /auth/login\n\nπ Description: Logs in a user with email and password.\n\nπ€ Request Body:\n\n{\n \"email\": \"user@example.com\",\n \"password\": \"password123\"\n}\n\n3. π₯ Role-Based Login\n\nπ URL: POST /auth/rolelogin\n\nπ Description: Logs in a user and includes role in the response.\n\n4. π² Send OTP\n\nπ URL: POST /auth/send-otp\n\nπ Description: Sends an OTP to the user's π phone number.\n\nπ€ Request Body:\n\n{\n \"phoneno\": \"+1234567890\"\n}\n\n5. β Verify OTP\n\nπ URL: POST /auth/check-otp\n\nπ Description: Verifies the OTP sent to the user's π phone.\n\nπ€ Request Body:\n\n{\n \"phoneno\": \"+1234567890\",\n \"otp\": \"123456\"\n}\n\nπ₯ Response:\n\n{\n \"message\": \"OTP verified successfully.\",\n \"token\": \"jwt-token\"\n}\n\n6. π‘οΈ Protected Route\n\nπ URL: GET /auth/protected\n\nπ Description: Access a protected route with a valid JWT.\n\nπ§Ύ Headers:\n\nAuthorization: Bearer \n\nπ₯ Response:\n\nThis route is protected\n\nπ§ͺ Testing\n\nUse a tool like Postman π¨ or cURL π» to test the endpoints.\n\nEnsure the .env variables are correctly set for Twilio π² and JWT π.\n\nπ Notes\n\nπ Database: The application uses Prisma as the ORM. Ensure that your database is configured correctly in the prisma.schema file.\n\nπ² Twilio Integration: Replace the Twilio credentials in the .env file with your own to enable OTP functionality.\n\nπ Password Hashing: Bcrypt is used for securely hashing passwords.\n\nπ‘οΈ JWT Tokens: Tokens are signed with a secret key defined in the .env file.\n\nπ License\n\nThis project is licensed under the MIT License. Feel free to use and modify it as needed.","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo-small.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/@nestjs/core.svg\")
\n![\"Package](\"https://img.shields.io/npm/l/@nestjs/core.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/@nestjs/common.svg\")
\n![\"CircleCI\"](\"https://img.shields.io/circleci/build/github/nestjs/nest/master\")
![\"Coverage\"](\"https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9\"){kind=icon}
\n![\"Discord\"/](\"https://img.shields.io/badge/discord-online-brightgreen.svg\"){kind=icon}
\n![\"Backers](\"https://opencollective.com/nest/backers/badge.svg\"){kind=icon}
\n![\"Sponsors](\"https://opencollective.com/nest/sponsors/badge.svg\"){kind=icon}
\n ![\"Donate](\"https://img.shields.io/badge/Donate-PayPal-ff3f59.svg\"){kind=icon}
\n ![\"Support](\"https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg\"){kind=icon}
\n ![\"Follow](\"https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow\")
\n