Документація

Feedbackie — це інструмент для збору відгуків та повідомлень про помилки в статтях, розроблений з використанням Laravel та адмін панелі FilamentPHP. Він може знадобитись блогерам та власникам веб-сайтів які хочуть покращити свій контент. Ви можете використовувати Cloud версію, або ж Self-hosted Open Source рішення.

Фактично, інструмент має дві функції:

  • Збір повідомлень про помилки: Легко збирайте виправлення помилок від відвідувачів вашого веб-сайту

  • Збір відгуків про корисність матеріалу: Відстежуйте наскільки користувачі вашого сайту вважають матеріали корисними.

Скільки б ми не намагались перечитувати написанні статті, в них всеодно залишаються граматичні помилки, неточності, пропущенні розділові знаки і тому подібне. Було б не погано, аби користувачі які читають статтю і бачать помилку могли запропонувати виправлення. Feedbackie дозволяє виділити текст на сторінці, виправити в ньому помилку, а потім відправити виправлення адміністратору.

Ось як це працює:

Крім того, сфера IT постійно розвивається і інформація в статтях застаріває. За допомогою інструменту зворотній звязок ви можете дізнатись які статті пора переписати чи актуалізувати.

Інтеграція на сайт

Інтегрувати інструмент на сайт досить просто. Достатньо вказати ідентифіактори HTML елементів куди буде вставлено напис з інформацією як відправити повідомлення про помилку, а також куди вставити попап з запитанням про корисність статті в конструкторі коду.

Виберіть сайт в адмін панелі, потім клікнуть по опції контекстного меню Code:

Заповніть ідентифіктори HTML елементів куди хочете вставити блоки:

Далі необхідно скопіювати згенерований код і вставити його в футер сайту на тих сторінках де ви хочете використовувати інструмент.

Запуск в Docker

Ви можете скористатись нашим Cloud рішенням, і тоді вам буде достатньо виконати кроки описані вище. Або ж ви можете розгорнути self-hosted версію з відкритим вихідним кодом на своєму сервері. Щоб подвитись як все працює можна розгорнути програму за допомогою docker: 

mkdir feedbackie
cd feedbackie
mkdir data
docker run -it --rm -v ./data:/data -p 80:80 seriyyy95/feedbackie-oss:latest

Зверніть увагу, що програма зберігає свої данні в каталогзі data, він має бути створений та змонтований в контейнер перед першим запуском. За замовчуванням використовується база данних SQLite. Програма автоматично створить користувача з логіном "admin" та паролем "password" і ви зможете залогінитись за адресою localhost.

Більше інформації про розгортання self-hosted версії проекту ви можете занйти в документації GitHub репозиторію: https://github.com/feedbackie/feedbackie-app

Якщо у ви знайшли помилку в програмі - створіть Issue в тому ж репозиторії.