0.2.2 • Published 1 year ago
ca-feedbacky v0.2.2
Feedbacky
Feedbacky is a web component that enables you to collect feedbacks into your web applications. It supports all major JavaScript frameworks and libraries including React, Vue.js, Angular, as well as VanillaJS
Features
- Works Anywhere: Works with React, Vue.js, Angular, or VanillaJS projects.
- Data Storage: All feedback is stored in SheetDB.
- Lightweight: Small footprint, minimal dependencies.
Installation and Usage
You can install Feedbacky via npm:
npm install ca-feedbacky
Usage
VanillaJS
<script type="module">
import 'ca-feedbacky';
</script>
<ca-feedbacky customerId="****" ></ca-feedbacky>
ReactJS
Demo: https://create-react-app-swart-kappa.vercel.app/
React is not compatible web component features. That's why file path is different.
import { CaFeedbacky } from "ca-feedbacky/ca-feedbacky-react.js"
<CaFeedbacky customerId="****"></CaFeedbacky>
VueJS
Demo: https://vite-vue-ten-liart.vercel.app/
<script setup>
import 'ca-feedbacky';
</script>
<CaFeedbacky customerId="****"></CaFeedbacky>
Angular
Demo: https://angular-boilerplate-qapm1uwwo-arascan35s-projects.vercel.app/
- Import the package in your module file
import 'ca-feedbacky';
- Import the component HTML file
<ca-feedbacky customerId="****" ></ca-feedbacky>
Feedbacks Storage
All feedback is stored in SheetDB.
https://docs.google.com/spreadsheets/d/16yMbwmd-7Oj1qeHddtAv2uWq2x_403dqRaG-ihRZDeA/edit?pli=1#gid=0
Dev - Installation
To run the Feedbacky app locally, follow these steps:
- Install the dependencies:
npm install
- Start the development server:
npm run start
- Open your web browser and visit
http://localhost:8000/demo/
to access the app.
Testing with Web Test Runner
To execute a single test run:
npm run test
To run the tests in interactive watch mode run:
npm run test:watch