{"id":17480294,"url":"https://github.com/integeralex/flexhostmail","last_synced_at":"2025-03-03T16:30:50.476Z","repository":{"id":224710406,"uuid":"764001960","full_name":"IntegerAlex/flexhostmail","owner":"IntegerAlex","description":"FlexHostMail is a Node.js package designed for secure email-based OTP (One-Time Password) verification systems. In this beta release, we introduce new functionalities and improvements to enhance your OTP implementation.","archived":true,"fork":false,"pushed_at":"2024-03-07T18:08:23.000Z","size":80,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-26T05:58:02.740Z","etag":null,"topics":["codecov","codescene","github-copilot","gitkraken","gitlens","learn","mailgun"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntegerAlex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-02-27T09:56:37.000Z","updated_at":"2024-04-30T18:54:26.000Z","dependencies_parsed_at":"2024-02-27T11:28:42.717Z","dependency_job_id":"f1a5261e-b437-4b8b-a548-b84c90a2cd43","html_url":"https://github.com/IntegerAlex/flexhostmail","commit_stats":null,"previous_names":["integeralex/flexhostmail"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2Fflexhostmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2Fflexhostmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2Fflexhostmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2Fflexhostmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntegerAlex","download_url":"https://codeload.github.com/IntegerAlex/flexhostmail/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241698971,"owners_count":20005297,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codecov","codescene","github-copilot","gitkraken","gitlens","learn","mailgun"],"created_at":"2024-10-18T21:43:17.525Z","updated_at":"2025-03-03T16:30:50.157Z","avatar_url":"https://github.com/IntegerAlex.png","language":"JavaScript","readme":"# Email OTP Verification System\n\n[![CodeScene Code Health](https://codescene.io/projects/50433/status-badges/code-health)](https://codescene.io/projects/50433)\n![workflow](https://github.com/IntegerAlex/flexhostmail/actions/workflows/main.yml/badge.svg)\n[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8456/badge)](https://www.bestpractices.dev/projects/8456)\n![NPM Version](https://img.shields.io/npm/v/flexhostmail)\n\n## Project Purpose\n\nThis Node.js project provides a system for secure email OTP (One-Time Password) generation, sending, and verification. It is designed for demonstration and learning purposes.\nIt uses Fastify over Express :  To focus on speed and efficiency, Fastify is optimized to handle a high volume of requests, making it an ideal choice for performance-critical applications where response time is a key factor.\n\n## Features\n\n- **OTP Generation:** Generates secure, random OTP codes.\n- **Email Integration:** Sends OTPs to users via email. Requires configuration with an email provider (Mailgun is supported).\n- **OTP Storage \u0026 Validation:** Securely stores OTPs as hashes in Redis for fast retrieval and validation(Redis is Required).\n\n## Setup\n\n### Prerequisites\n\n- Node.js\n- npm\n- Mailgun account\n- Running Redis instance\n\n### Instructions\n\n1. Clone the repository.\n2. Install dependencies: `npm install`.\n3. Create a `.env` file (never committed to version control) with the following fields:\n\n   ```plaintext\n   MAILGUN_API_KEY=your_mailgun_api_key\n   REDISHOST=your_redis_hostname_or_ip\n   REDISPASSWORD=your_redis_password\n   MAILGUN_DOMAIN=your_mailgun_domain\n\n### Start  \n\n```bash\n    `node index.js`\n```\n\n```zsh\n    `it listen to port localhost:9543` expose port according to your requirement\n```\n\n[documentations](./docs.md)\n\n### License\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintegeralex%2Fflexhostmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintegeralex%2Fflexhostmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintegeralex%2Fflexhostmail/lists"}