fidbee
v1.1.0
Published
Easy feedback from your React app
Downloads
29
Readme
Fidbee - Easy feedback from your app
Fidbee is a lightweight feedback collector inspired by UserSnap. It's Free, Open-Source and self-hostable.
Getting started
- Install
fidbee
React component in your app - Connect your serveur to receive webhooks
Install Fidbee in your frontend app
Fidbee React component uses Material UI as a peer dependency. You need to install this external lib in your project by your own in order to use Fidbee.
npm install --save fidbee
# or
yarn add fidbee
Then, in your code:
import { Fidbee } from "fidbee";
const WEBHOOK_URL = "http://localhost:4000";
const PROJECT_NAME = "Demo Fidbee";
function App() {
return (
<>
<Fidbee webhookUrl={WEBHOOK_URL} projectName={PROJECT_NAME} />
</>
);
}
export default App;
A Support button appears in the bottom-right edge of the screen. If a user fills the feedback form, a webhook is sent to the configured webhook URL.
See an example of usage in the demo directory.
Parameters
projectName
[required] - string : Name of the project/appwebhookUrl
[required] - string : URL to send to webhooks on new messageuserEmail
- string : Pre-filled email in formallowAnonymous
- boolean : Allow/Disallow messages without email
Connect your server
Fidbee React component sends a webhook to a backend. An mere example is available in the server-example directory.
This server sends an email notifications by SMTP when a new feedback is received.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Build & Publish
Fidbee uses dnt for package building.
yarn build
cd npm/
npm publish
Authors
- Octree - sustainable startup studio - https://octree.ch
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details