js-feedbacky

Feedbacky

Feedbacky is a JavaScript library designed to simplify the process of collecting user feedback.

Installation

To use Feedbacky, you need to install it via npm with the following command:

npm install js-feedbacky

After that, you can import Feedbacky into your project like this:

import Feedbacky from "js-feedbacky";

Usage

To use Feedbacky, you can include the following code in a JavaScript file or directly in an HTML file:

<script>
  Feedbacky.init({
    apiKey: 'YOUR_API_KEY_HERE',
    options: {
      button: {
        text: 'Send Feedback',
        color: '#fff',
        backgroundColor: '#000',
        zIndex: 9999,
      }
    }
  });
</script>

In the above example, replace 'YOUR_API_KEY_HERE' with your actual API key. You can also customize options such as button text and colors to match your application's design.

Demo and Testing Environment:

You can access a demo version of Feedbacky and test it on the following website: Feedbacky Demo

• You can log in using the credentials:
  • Username: test
  • Password: test
• Alternatively, you can register at Feedbacky Registration to obtain your API key and then use it to log in.

Please note that these are demo credentials for testing purposes only.

Code Coverage

To measure code coverage in the Feedbacky project, you can follow these steps:

1. Customize code coverage configuration using the .nycrc file located in the project's root directory.

2. Generate a code coverage report with the following command:

npm run test -- --coverage

3. The code coverage report will be generated in the coverage folder. You can review the reports and make improvements as needed.

4. To view the code coverage report in your web browser, use the following command:

npm run coverage:report

This command will open the code coverage report in your browser.

Contributing

If you'd like to contribute to the Feedbacky project, please visit the GitHub repository: Feedbacky GitHub Repository