Skip to content
/ feedback Public

💬 feedback - the only way to leave anyone "constructive criticism" with anonymity and/or privacy for those giving it!

Notifications You must be signed in to change notification settings

dwyl/feedback

Repository files navigation

feedback

An anonymous feedback mechanism guaranteeing anonymity to those providing it.

Try it: https://dwyl-feedback.herokuapp.com

feedback-app-screenshot

Why?

We all have things we would like to improve in our lives and work. But often we do not know how to approach communicating the "issue" without offending someone. If we just ignore the issue or "bottle it up" without saying anything, the issue rarely just "goes away".

We need a systematic way of sharing feedback on anything. So that anyone can describe an issue, capture and address it.

What?

  • Collect anonymous feedback from anyone.
  • Store that feedback in a simple database
  • Act on the feedback and show progress towards solving any issues raised.

Initially the feedback will only be internal but we need to discuss the potential for how to make it public please share your thoughts on this: #2

Who?

Who is the feedback app made for?

Initially this app is for our internal purposes. We @dwyl are doing a terrible job of collecting feedback from all the team members, clients, "users" of the apps we build and other stakeholders.

The feedback app addresses this challenge.

Who might the feedback app be useful to in the future?

Any organsiation or individual who needs a systematic way of collecting both specific/targeted and anonymous feedback.

How?

To run this app locally, you will need to have some basic Phoenix Knowledge. We recommend reading: https://github.com/dwyl/learn-phoenix-framework

Get Started in 2 Minutes

  • Clone the Git repository: git clone git@github.com:dwyl/feedback.git && cd feedback
  • Install dependencies with mix deps.get && npm install
  • Create and migrate your database with mix ecto.create && mix ecto.migrate
  • Set environment variables:
    • ADMIN_EMAIL - the email that you want to log in with (must also be verified by AWS)
    • ADMIN_PASSWORD - the password you want to log in with
    • SECRET_KEY_BASE - taken from config.exs
    • TARGET_EMAIL - verified SES email for testing
    • SES_SERVER - your SES server
    • SES_PORT - your SES port
    • SMTP_USERNAME - your SMTP username
    • SMTP_PASSWORD - your SMTP password
    • DEV_URL - http://localhost:4000
    • PROD_URL - url of the live site
  • Run priv/repo/seeds.exs
  • Run source .env to load your environment variables
  • Start Phoenix endpoint with mix phoenix.server

Now visit localhost:4000 from your web browser.

Research

See the research.md file.

Conclusion

We have surveyed the market and can conclude that there isn't an existing Open-Source, easy-to-run application or Service with an API we can use in April 2017 so we decided to make one.

About

💬 feedback - the only way to leave anyone "constructive criticism" with anonymity and/or privacy for those giving it!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published