FEATURE HUNT, Build It Better!

INTRODUCTION ⚡️

Stop letting ideas slip through the cracks. Collect, analyze, and organize feedback and feature requests in your product's feedback board to make better product decisions.

Feature Hunt is a platform that allows you to do just that. Users can share/vote/discuss feature requests and product owners can organize them to make better product decisions 🎯.

Watch this short video to know more:

PK9G9OSXV7FK4V3K.mp4

The following technologies were used for the development of this project:

React (P.S. we use hooks)
JavaScript
Python3
Flask
MongoDB
HTML
CSS

Although we haven't used any CSS library for the FrontEnd, the users can easily merge it with any CSS library of their choice (e.g. Tailwind CSS, react-bootstrap).

Preview

The Home Page - It has a list of different products for which you can provide feature requests

The Product Page - It has a list of feature requests added by users

The Comment Section - Each product page has a comment section (Powered by utteranc.es)

Add Your Project

Want to gather feedback and maintain your project's roadmap more efficiently?

You can add your project to Feature Hunt by filling this form, our team will review the response and add it to our database after doing our due diligence.

Getting Started with Development

There are two ways to install and develop for featurehunt

Method 1) Using Docker containers.

Method 2) Using Local machine.

Installation With Dockers.

STEP 1) Follow the steps to install Docker for your OS

https://docs.docker.com/get-docker

STEP 2) Git clone the Repository using

git clone https://github.com/shahrk/feature-hunt.git

STEP 3) Run the following Commands

cd feature-hunt

docker-compose up

This will start create two docker interfaces. The frontend will listen on 3000 and backend start on 5000

Installation in Local Machine without Dockers.

First Time Setup

STEP 1) Git clone the Repository using

git clone https://github.com/shahrk/feature-hunt.git

STEP 2) Run the following Commands

cd feature-hunt

STEP 3)

In the project directory run git config --local core.hooksPath hooks to make sure you have access to the Git Hooks. Run the following commands in order:

STEP 4) npm install

Installs the dependencies for the React App

STEP 5) pip install -r api/requirements.txt

Installs the requirements for the Flask API

STEP 6) yarn start

Runs the frontend React app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

STEP 7) yarn start-api

Runs the backend flask API in development mode.
The API runs on http://localhost:5000.

Requests made to http://localhost:3000 that don't exist on the react server are automatically forwarded to this API

Getting Started with Database Development/Connection

STEP 1) Make an account on Mongo Cloud Atlas

STEP 2) Make a Database and grab the credentials by clicking on connect

STEP 3) Make the corresponding changes in the config.yaml file located in api folder

Other Available Scripts

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

Contributors 🎯

Raj Shah

Nirav Patel

Parth Kanakiya

Mithil Dave

Bhargav Jethwa