1.0.0 • Published 7 months ago

@gokayerim/feedback v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
7 months ago

Feeback Client

Bu projenin amacı kendi projelerinden müşteri yorumlarını toplama amacı ile geliştirilmiş.

Demo

Default Component için tıklayınız

Customized Component için tıklayınız

Install

npm i @gokayerim/feedback
yarn add @gokayerim/feedback

Usage

Feedback componentini eklemek istediginz sayfaya aşağıda ki kodları yazarak kullanabilirsiniz.

import Feedback from '@gokayerim/feedback';
...

return(
    ...
   <Feedback vendorId={vendorId} />
    ...
)

Not: Komponenti kullanabilmek için geçerli bir vendorId'iniz olmalıdır. Demo amaçlı aşagıdaki vendorId'leri kullabilirsiniz.

  • Vendor1
  • Vendor2

Run Locally

Terminal ile projeye girip dependency'ileri indirikten sonra aşağıdaki komutu çalıştırarak lokal ortamda çalıştırabilirsiniz.

yarn dev

Not: Lokal ortamda sorgu yapabilmeniz için Server uygulamasını da çalıştırmalısınız. Server Uygulaması README dosyasına ulaşmak için lütfen tıklayın.

Run with Remote Server

Lokal Backend yerine uzak sunucu ile çalıştırmak için aşağıdakı komutu kullanabilirsiniz.

yarn dev:prod

Props

PropisMandatorytypeDesciption
vendorIdtruestringYorumun kaydedileceği vendorId
customButtonClassNamefalsestringButton için custom css classı
customButtonElfalseJSX.ElementButton için custom element
onButtonClickfalsefuncButton tıklanıldığında tetiklenecek fonksiyon
customFeedbackModalClassNamefalsestringFeedback Modalı için custom css classı
customFeedbackModalTitlefalsestringFeedback Modalı custom başlığı
maxFeedbackLengthfalsenumberGirilebilecek max feedback uzunluğu (varsayılan 2000)
onFeedbackSubmitfalsefuncSubmit tıklanıldığında tetiklenecek fonksiyon
customSuccessModalClassNamefalsestringSuccess Modalı custom custom css classı
customSucessMessagefalsestringSuccess Modal mesajı

Unit Tests

Unit testleri çalıştırmak için aşağıdaki komutu çalıştırabilirsiniz.

yarn test

Coverage Rapor için ise şu komutu kullanmalısınız.

yarn test:coverage

Tech Stack

Proje gelşitirilirken kullanılan teknolojiler/frameworkler/kütüphaneler aşağıda listelenmşir.

  • React/Typescript
  • Vite
  • react-icons
  • Firebase (Hosting)
  • Jest/Enzyme
1.0.0

7 months ago

0.1.3

7 months ago

0.1.2

7 months ago

0.1.1

7 months ago

0.1.0

7 months ago

0.0.3

7 months ago

0.0.2

7 months ago

0.0.1

7 months ago