# feedbacky-app

> Feedback app is a lightweight app. It is easily applied to your site and stores users' feedback in the database.

Latest version **0.1.6** (published 2023-07-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install feedbacky-app
pnpm add feedbacky-app
yarn add feedbacky-app
bun add feedbacky-app
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2023-07-24 |
| First published | 2023-07-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 33 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kerem Karadeniz |
| Maintainers | keremkaradenzz |
| Keywords | react, typescript, feedbacky |

## Links

- npm: https://www.npmjs.com/package/feedbacky-app
- Repository: https://github.com/DevelopmentHiring/KeremKaradeniz1
- Homepage: https://github.com/DevelopmentHiring/KeremKaradeniz1#readme
- Issues: https://github.com/DevelopmentHiring/KeremKaradeniz1/issues
- npm.io page: https://npm.io/package/feedbacky-app

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.6 (latest) — 2023-07-24
- 0.1.5 — 2023-07-23
- 0.1.4 — 2023-07-23
- 0.1.3 — 2023-07-23
- 0.1.1 — 2023-07-23
- 0.1.0 — 2023-07-23

## README

# Feedbacky App
Feedback app is a lightweight app. It is easily applied to your site and stores users' feedback in the database.

<img width="451" alt="Screen Shot 2023-07-24 at 12 27 46" src="https://github.com/DevelopmentHiring/KeremKaradeniz1/assets/64808302/1fffb6d8-4327-43e3-a7bc-336ea4a3d9d6">
<img width="395" alt="Screen Shot 2023-07-24 at 12 29 35" src="https://github.com/DevelopmentHiring/KeremKaradeniz1/assets/64808302/8b236939-6c9b-410c-8b40-f919aadbc7aa">


<hr/>


###  Installation
```bash
npm install feedbacky-app
```
OR 
```bash
yarn add feedbacky-app
```

```javascript
import { Feedbacky } from "feedbacky-app";

function App() {
    const feedBackyProps = {
        appId: "TEST",
        apiUrl: "https://f-backend-d71e84d46dd0.herokuapp.com/",
        sendButtonLabel: 'Send',
        successMessage: 'Thanks for your feedback!',
        titleColor: 'black',
        title: 'Send your feedback',
        placeholder: 'Enter your feedback',
        backgroundColor: 'rgba(0, 0, 0, 0.2)',
        modalStyle: {
          backgroundColor: '#fff',
          border: '1px solid #fafafa',
        },
    };

    return (
        <main className="App">
            <Feedbacky {...feedBackyProps} />
        </main>
    );
}
export default App;
```

## Documentation

| Props*               | Description | **type** | **required** | **default props**                  |
|----------------------| ----------- | -------- | ------------ | ---------------------------- |
| appId        | Your App ID         | string   | true         | null                         |
| apiUrl            |  Backend Api URL | string   | true         | null                         |
| sendButtonLabel       | Submit form button text   | string   | false         |  'Send',                         |
| successMessage      |  Success Message Text   | string   | false         | 'Thanks for your feedback!',                         |
| titleColor  | Submit form title color         | string   | false             | 'black'                         |
| title | Submit form title text           | string   | false             | 'Send your feedback',       |
| placeholder            |  Submit form feedbacky input placeholder text       | string   | false  | 'Enter your feedback', |
| backgroundColor        | background color outside modal | string   | false         | 'rgba(0, 0, 0, 0.2)                         |
| modalStyle   |  Style for modal  | React.CSSProperties (Object)   | false         | {backgroundColor: '#fff', border: '1px solid #fafafa'}  |

## Admin Panel
 [admin dashboard](https://feedbacky-admin-5b861d0b4ab3.herokuapp.com/) You can see their feedback by logging in.
<hr/>
Feedbacks List
<img width="1670" alt="Screen Shot 2023-07-24 at 12 23 20" src="https://github.com/DevelopmentHiring/KeremKaradeniz1/assets/64808302/8d7b3df3-b753-4977-ba79-014916b0da35">



### NOTE: Only admin can create user account.
Generating APP ID
<img width="1684" alt="Screen Shot 2023-07-24 at 12 23 13" src="https://github.com/DevelopmentHiring/KeremKaradeniz1/assets/64808302/5da78c1a-68ac-4f22-8f36-d4df81399d99">


EXAMPLE USER = { 
  email: test@feedback.com
  password: test123
} 

ADMIN USER = {
  email: admin@admin.com
  password: admin123
 } 

## Example  [DEMO](https://feedbacky-example-b30ef7d8d24e.herokuapp.com/) 

TEST COVERAGE : 100%

---
_Source: https://npm.io/package/feedbacky-app · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._