fawkes

What's fawkes ?

Fawkes is a platform designed for product-managers as well as product development teams to get a consolidated view on how well the product is doing from a customer perspective, getting the top issues that the customers are talking about, their sentiments and how they are feeling about the product.

Architecture

Features

• 🚀 Integration with multiple data source
• ⚡️ Kibana dashboard for searching and filtering data
• 💎 Simple, Configurable and Powerful
• 🔥 Built entirely using open-source tools

Onboarding

• Fork this repo
• Add your app's config in the app/ folder. Look at the sample configs for reference.
• Enable CircleCI for your application
• 🎉🎊 That's All 🎉🎊

Configuration

• Create a config file for your app. If your app name is mint, create a file like app/sample-mint-config.json
• There are some app level configs.
• To add user feedbacks/verbatims from a channel, we need to add an entry into review-channels array.

App. level configs

Config Key Name	Description
app	App. Name
elastic-search-index	The elastic search index to upload data to.
lifetime-rating-elastic-search-index	The elastic search index to upload the lifetime ratings. It needs to uploaded to a different index because it does not follow the lifecycle of a normal REVIEW.
app-logo	The URL for the logo of the app.
email-time-span	The time filter in days to use for sending summary emails.
bug-feature-file	The file which contains the weight and keywords for categorizing the user feedback to bugs/features.
topic-keywords-file	The file which contains the weight and keywords for categorizing the user feedback to different categories.
algorithm-days-filter	The filter in days to apply to filter out the feedbacks. This will be applied while parsing, running algorithms etc.
email-subject-name	The subject name for the summary emails.
email-list	The list of email addresses to send the summary email.
sendgrid-api-key	We use Sendgrid to send emails.
slackbot-run-interval	The time interval to filter the feedbacks to send to the slack channel.
slack-hook-url	The slack web-hook used to send the slack notifications.
slack-channel	The name of the slack channel
jira	Coming Soon!
review-channels	List of channel configs.

Contributing

For details on how to contribute to this project see CONTRIBUTING.md