Skip to content

Commit 1447160

Browse files
update readme.md
1 parent a04cc0f commit 1447160

File tree

1 file changed

+10
-22
lines changed

1 file changed

+10
-22
lines changed

readme.md

+10-22
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# External REST API Integration, Avatar Management, and Jest Testing
1+
# Email Verification with Nodemailer
22

33
<img align="right" src="https://media.giphy.com/media/du3J3cXyzhj75IOgvA/giphy.gif" width="100"/>
44

@@ -8,16 +8,13 @@
88
[![MongoDB](https://img.shields.io/badge/MongoDB-v6.3.0-3B9539)](https://www.mongodb.com/)
99
[![Mongoose Version](https://img.shields.io/badge/Mongoose-v8.4.3-6B0002)](https://mongoosejs.com/)
1010
[![JWT](https://img.shields.io/badge/JSON%20Web%20Token-v9.0.2-000000)](https://jwt.io/)
11-
[![Jest](https://img.shields.io/badge/Jest-v29.7.0-A7001B)](https://jestjs.io/)
12-
[![Gravatar](https://img.shields.io/badge/Gravatar-v1.8.2-1C78B0)](https://en.gravatar.com/)
11+
[![Nodemailer](https://img.shields.io/badge/Nodemailer-v6.9.14-0076C8)](https://nodemailer.com/)
1312

14-
Welcome to the fifth homework assignment in the Fullstack Bootcamp, where we continue to build upon the foundation laid by our previous projects, especially those emphasizing HTTP requests. This module signifies a shift in focus towards more advanced features.
15-
In this stage, we explore the integration of sophisticated functionalities, such as the ability to add avatars for users upon creation. This enhancement not only adds a personalized touch to user profiles but also enriches the overall user experience.
16-
Additionally, we delve into the world of Jest unit testing, ensuring the reliability and robustness of our application. This step reflects our commitment to delivering high-quality Fullstack solutions. As we integrate these innovations, we look forward to the unfolding possibilities on our journey of continuous skill development.
13+
The sixth homework assignment marks a pivotal advancement in our ongoing project, seamlessly building upon the foundations established in prior modules. In this iteration, we introduce a critically important feature—email verification—leveraging the robust capabilities of the Nodemailer API. This module is meticulously crafted with a singular focus: to fortify user security and elevate the precision of access control mechanisms within our application.
1714

18-
## Homework5: External REST API Integration, Avatar Management, and Jest Testing
15+
## Homework6: Email Verification with Nodemailer
1916

20-
The fifth homework assignment builds upon the solid foundation of previous projects, expanding the capabilities of the application to include external REST API integration, avatar management, and Jest testing for enhanced functionality and reliability.
17+
The sixth homework assignment builds upon prior projects, introduces a crucial feature—email verification using the Nodemailer API. This module is dedicated to fortifying user security and refining access control within our application.
2118

2219
## API Endpoints
2320

@@ -37,25 +34,15 @@ The fifth homework assignment builds upon the solid foundation of previous proje
3734
- **(POST) `/api/users/logout`:** Logout the user.
3835
- **(GET) `/api/users/current`:** Retrieve information about the currently logged-in user.
3936
- **(PATCH) `/api/users/avatars`:** Change the user's avatar.
37+
- **(GET) `/api/users/verify/:verificationToken`:** Verify the user's email address using the provided token.
38+
- **(POST) `/api/users/verify`:** Request a second verification email.
4039

4140
### Additional Endpoints
4241

4342
- **(GET) `/api/contacts?page=<page_number>&limit=<page_size>`:** Retrieve paginated contacts.
4443
- **(GET) `/api/contacts?favorite=true`:** Retrieve contacts marked as favorites.
4544
- **(PATCH) `/api/users`:** Update the user's subscription level.
4645

47-
## Avatar Management
48-
49-
- Avatars are automatically generated for new users using the ![Gravatar](https://img.shields.io/badge/Gravatar-1E8CBE.svg?style=for-the-badge&logo=Gravatar&logoColor=white) package.
50-
- Introduces a new endpoint `(PATCH) /api/users/avatars` for users to change their avatars.
51-
- Jimp package is utilized for image processing related to avatars.
52-
53-
## Jest Testing for Login
54-
55-
- Implements ![Jest](https://img.shields.io/badge/Jest-C21325.svg?style=for-the-badge&logo=Jest&logoColor=white) testing to ensure the robustness of the login functionality.
56-
- Unit tests are created to validate the authentication system, enhancing the overall reliability of the application.
57-
- Run tests using `npm run test` script defined in the package.json file.
58-
5946
## Technologies Used
6047

6148
- ![Node.js](https://img.shields.io/badge/Node.js-339933.svg?style=for-the-badge&logo=nodedotjs&logoColor=white): The runtime environment for executing the application.
@@ -64,8 +51,7 @@ The fifth homework assignment builds upon the solid foundation of previous proje
6451
- ![JSON Web Token](https://img.shields.io/badge/JSON%20Web%20Tokens-000000.svg?style=for-the-badge&logo=JSON-Web-Tokens&logoColor=white): Used for user authentication.
6552
- ![Express.js](https://img.shields.io/badge/Express-000000.svg?style=for-the-badge&logo=Express&logoColor=white): A web application framework for building RESTful APIs.
6653
- ![JSON](https://img.shields.io/badge/JSON-000000.svg?style=for-the-badge&logo=JSON&logoColor=white): Data interchange format used in the project.
67-
- ![Jest](https://img.shields.io/badge/Jest-C21325.svg?style=for-the-badge&logo=Jest&logoColor=white):JavaScript testing framework ensuring code reliability and simplicity.
68-
- ![Gravatar](https://img.shields.io/badge/Gravatar-1E8CBE.svg?style=for-the-badge&logo=Gravatar&logoColor=white): Global avatar service for user profile images linked to email addresses.
54+
- ![Nodemailer](https://img.shields.io/badge/Nodemailer-0076C8.svg?style=for-the-badge&logo=nodemailer&logoColor=white): Email sending module for Node.js.
6955

7056
## Issues
7157

@@ -75,6 +61,7 @@ If you encounter any issues or have suggestions, please [open an issue](https://
7561

7662
I welcome feedback and suggestions from users to improve the application's functionality and user experience.
7763

64+
7865
## Languages and Tools:
7966

8067
<div align="center">
@@ -84,4 +71,5 @@ I welcome feedback and suggestions from users to improve the application's funct
8471
<a href="https://expressjs.com/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/express-colored.svg" width="36" height="36" alt="Express" /></a>
8572
<a href="https://www.jestjs.io/" target="_blank"><img style="margin: 10px" src="https://profilinator.rishav.dev/skills-assets/jest.svg" alt="Jest" height="50" /></a>
8673
<a href="https://git-scm.com/" target="_blank" rel="noreferrer"> <img src="https://www.vectorlogo.zone/logos/git-scm/git-scm-icon.svg" alt="git" width="40" height="40"/></a>
74+
<a href="https://postman.com" target="_blank" rel="noreferrer"><img src="https://www.vectorlogo.zone/logos/getpostman/getpostman-icon.svg" alt="postman" width="40" height="40"/></a>
8775
</div>

0 commit comments

Comments
 (0)