Feedy
Feedback widget for your web apps. Made with Webcom
Features
- Send feedback
- Make screenshot on demand
- Save useragent
- Add custom data
- Authentication
- Authentication into Webcom
- Authentication with third-party
- Anonymous user (give arbitrary email)
- Secure namespace
- Comments on feedbacks
- Admin website
- Deactivate widget if needed
How to use it
Add this markup into your website
<script src="https://npmcdn.com/feedy@latest/dist/feedy.js"></script>
Add this markup at the end of <body>
<script>
feedy({
// optional, default is 'https://webcom.orange.com/base/feedy'
namespaceUrl: 'https://webcom.orange.com/base/<YOUR_NAMESPACE>',
// optional, default is 'general'
appName: '<YOUR_APP_NAME>'
// optional, screenshot activated. Default is true
screenshot: true or false
});
</script>
How to contribute
Ensure you have [node][node-link] greater than version 4 (Code contains es6 syntax)
Installation
-
Get repo with
git clone https://github.com/webcom-components/feedy.git
-
Run
npm install
to install the dependencies
Development server (with hot reload)
npm start
Go to http://localhost:8080
and you should see the app running!
Build for production
npm run build
Output files are copied to dist
folder
Serve production files
npm run serve
License
This project is licensed under the MIT license