https://github.com/soufantech/ephemeral-codes
Manages temporary codes for password recovery, user registration and other use-cases.
https://github.com/soufantech/ephemeral-codes
password-recovery redis temporary user-registration
Last synced: 6 months ago
JSON representation
Manages temporary codes for password recovery, user registration and other use-cases.
- Host: GitHub
- URL: https://github.com/soufantech/ephemeral-codes
- Owner: soufantech
- License: mit
- Created: 2021-01-13T02:16:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-15T03:08:00.000Z (over 4 years ago)
- Last Synced: 2025-03-25T21:45:27.833Z (7 months ago)
- Topics: password-recovery, redis, temporary, user-registration
- Language: JavaScript
- Homepage:
- Size: 163 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@soufantech/ephemeral-codes
Manages temporary codes for password recovery, user registration and other use cases.
[![jest-image]][jest-url] [![npm-image]][npm-url]
## 💾 Installation:
@soufantech/ephemeral-codes depends on [ioredis](https://github.com/luin/ioredis) version ^4. Be sure to install it if you don't have it already in your project.
You can install this package (and ioredis) with yarn:
```console
yarn add ioredis@^4 @soufantech/ephemeral-codes
```
or npm:
```console
npm install ioredis@^4 @soufantech/ephemeral-codes
```
## 🚴 Usage:
Usage documentation hasn't been provided yet. Please, refer to the tests for usage examples.
## 🔤 API docs:
API documentation hasn't not been provided yet. Please, refer to the source code.
## 🧪 Testing:
1. Copy the contents of the `.env.example` file to an `.env` file in the same directory.
1. Run `docker-compose up` to spin up a redis container.
2. Run `yarn test` (or `npm run test`) to execute the tests.
---
[npm-image]: https://img.shields.io/npm/v/@soufantech/ephemeral-codes.svg?style=for-the-badge&logo=npm
[npm-url]: https://npmjs.org/package/@soufantech/ephemeral-codes "npm"
[jest-image]: https://img.shields.io/badge/tested_with-jest-99424f.svg?style=for-the-badge&logo=jest
[jest-url]: https://github.com/facebook/jest "jest"