Skip to content

mdmuhtasimfuadfahim/lovemate

Repository files navigation

NPM Version NPM Monthly Downloads

Last Commit Language Most Used Implementations Repository Size

Forks Stars Watches

Author GitHub

lovemate 💖🎵

lovemate is a fun npm package designed to express affectionate phrases in various languages through voice.

Table of Contents

Description

Solumate provides an extensive repertoire of romantic phrases in over 30+ languages, each complemented by a voice recording, text, and voice URL. Users can leverage these features to convey their affection to their loved ones with ease. Simply install the package and execute it to access a diverse array of heartfelt expressions, enhancing your communication in a myriad of languages.

Currently, users can hear the phrases in a female voice, with plans to add male voice options in the future.

Supported Languages

lovemate supports a wide range of languages, including:

  • af-ZA: Afrikaans (South Africa)
  • ar-XA: Arabic (Gulf)
  • bn-IN: Bengali (India)
  • cs-CZ: Czech (Czech Republic)
  • da-DK: Danish (Denmark)
  • de-DE: German (Germany)
  • el-GR: Greek (Greece)
  • en-AU: English (Australia)
  • en-GB: English (United Kingdom)
  • en-IN: English (India)
  • en-US: English (United States)
  • es-ES: Spanish (Spain)
  • es-US: Spanish (United States)
  • fi-FI: Finnish (Finland)
  • fil-PH: Filipino (Philippines)
  • fr-CA: French (Canada)
  • fr-FR: French (France)
  • hi-IN: Hindi (India)
  • hu-HU: Hungarian (Hungary)
  • id-ID: Indonesian (Indonesia)
  • it-IT: Italian (Italy)
  • ja-JP: Japanese (Japan)
  • ko-KR: Korean (South Korea)
  • nb-NO: Norwegian (Norway)
  • nl-NL: Dutch (Netherlands)
  • pl-PL: Polish (Poland)
  • pt-BR: Portuguese (Brazil)
  • pt-PT: Portuguese (Portugal)
  • ru-RU: Russian (Russia)
  • sk-SK: Slovak (Slovakia)
  • sv-SE: Swedish (Sweden)
  • ta-IN: Tamil (India)
  • tr-TR: Turkish (Turkey)
  • uk-UA: Ukrainian (Ukraine)
  • vi-VN: Vietnamese (Vietnam)
  • zh-CN: Chinese (Mandarin, Simplified)
  • zh-HK: Chinese (Cantonese, Traditional)
  • zh-TW: Chinese (Mandarin, Traditional)

Dependencies and API

lovemate uses the following npm packages:

  • google-tts-api: This package is used to generate the audio files from the translated phrases.
  • google-translate-api-x: This package is used to translate the phrases into the desired language.
  • play-sound: This package is used to play the generated audio files.

In addition, lovemate uses the quotable.io API to fetch random love quotes.

Installation

To install lovemate, use npm or yarn:

npm install lovemate

or

yarn add lovemate

Usage

const lovemateVoice = require("lovemate");

(async () => {
  try {
    const language = "bn-IN"; // Specify the language (e.g., 'en-US' for English, 'es-ES' for Spanish, etc.)
    const phrase = await lovemateVoice(language); // for English you don't need to pass the language parameter
    console.log("Message played successfully!", phrase);
  } catch (error) {
    console.error("Error:", error.message);
  }
})();

📜 License

Copyright © 2023 Md. Muhtasim Fuad Fahim

This project is licensed under the MIT License. This license allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software. However, you must include the original copyright notice and disclaimers.

For more information about this license, please visit MIT License.

👤 Author

🤓 Md. Muhtasim Fuad Fahim [email protected]

📝 Contribution

Contributions, issues, and feature requests are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • Fork the Project
  • Create your Feature Branch (git checkout -b feature/AmazingFeature)
  • Commit your Changes (git commit -m 'Add some AmazingFeature')
  • Push to the Branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

Feel free to check the issues page for any existing issues or to create a new one.

  • Contributions, issues and features requests are welcome!
  • 📮 Submit PRs to help solve issues or add features
  • 🐛 Find and report issues
  • 🌟 Star the project