Giter Site home page Giter Site logo

feedy's Introduction

Feedy

Build Status Dependency Status devDependency Status semantic-release

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>' 
});
</script>

How to contribute

Ensure you have [node][node-link] greater than version 4 (Code contains es6 syntax)

Installation

  1. Get repo with git clone https://github.com/webcom-components/feedy.git

  2. 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

feedy's People

Contributors

paulmusso avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.