Skip to content

n4ze3m/feedback-board

Repository files navigation

Feedback Board

An open source tool that allows you to gather feedback from your users or customers, prioritize the most important feedback, and keep your team organized and informed. With features like email notifications, unlimited boards, upvotes, and comments, this tool is designed to make it easy to collect and manage feedback in a collaborative and efficient way.

Features

  • Email Notifications: Receive updates about feedback you have submitted or voted on.
  • Unlimited Boards: Create and manage multiple feedback boards for different projects or departments.
  • Upvotes and Comments: Interact with feedback and express your opinions.
  • AI powered spam detection: CoHere NLP is used to detect spam and offensive content.

Self-hosting

Prerequisites

Installation

  1. Clone the repository
git clone https://github.com/n4ze3m/feedback-board.git
  1. Install dependencies
cd feedback-board

npm install
  1. Create a Supabase project and a new database

  2. Create a new table in the database and name it feedback with the following columns:

npx prisma db push
  1. Execute the query from SUPABASE.sql in the SQL editor of your Supabase project

  2. Copy the .env.example file and rename it to .env and fill in the required values from your Supabase project

  3. On your Courier project, create a template with the following variables:

  • {subject}
  • {message}
  • {btnText}
  • {btnLink}
  1. Copy the template ID and API key from your Courier project and add them to the .env file

9 (optional). If you want to use CoHere NLP to detect spam, create an account and add the API key to the .env file

  1. Start the development server
npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

Contributing

We welcome contributions from the community! If you find a bug or have a suggestion for a new feature, please open an issue. If you would like to contribute code, please submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.