The feature-hunt from sumedh-patkar

📋 Table of contents

🎯 Introduction

Being able to receive and track feedback from customers is a valuable tool when it comes to product development.

Feature Hunt allows one to effortlessly submit, endorse, and participate in discussions surrounding feature and change requests. The software also allows product administrators to efficiently categorize and prioritize submissions to strengthen their decision making process.

Start leveraging Feature Hunt today to help you make informed decisions for your product.

🖥️ Technologies

Feature Hunt is built with:

Docker

React

MongoDB

Python

JavaScript

HTML

CSS

📎 Usage Instructions

Landing Page

Our intuitive home page is the first thing you'll see. If you're a new user, go ahead and click the login button. Otherwise, the sign up button will allow you create a new account for Feature Hunt.

Signing Up

Logging In

Feed Page

Once you're logged in, you'll be greeted by the Feed page. Here, you can view existing products as well as express your feedback by upvoting or downvoting. Clicking on the product also allows you to view more information about it.

Product Details

Company and Product Creation

If you'd like to add your own product and have it available for feedback, you'll first have to create a Company. To do this, click "Create Company" first at the top left. This will bring you to the company creation page where you can enter details such as a brief description or keywords.

Product Creation

With the creation of your company, you can click the "Create Product" button at the top left to add your product to Feature Hunt. Make sure to select the right company for your product!

🏁 Getting Started

Dependency Setup

First Time Setup

1. Git clone the Repository using

git clone https://github.com/Sumedh-Patkar/feature-hunt.git

2. Run the following Commands

cd feature-hunt
cd app

3. `pip install -r backend/requirements.txt`

Installs the requirements for the Flask API

4. `python app.py`

Runs the Flask app in the development mode.
Open http://localhost:5000 to view it in the browser.

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

Connecting with a Database

We use Mongo Cloud Atlas for our project as we find it very convenient. You may choose to use a local mongodb instance or run a docker container

Check out our tutorial to get started with creating and connecting to a database.

Deployment

This app has been deployed using Deta Space. Check it out here!

You can now run and test the project locally and in deployments. More info about our deplyments and switching between production and devlopment can be found in our Wiki

🆕 Changelog

Version 5.2

11/27/2023

Migrated frontend to React
Rebuilt the UI from the ground up
Added support for user uploadable images

Version 5.1

11/24/2023

Added support for Docker
Fixed major critical breaking bugs and issues
Fixed voting functionality

🔮 Future Scope

We fully believe in supporting and updating our products and Feature Hunt is no different. Below are the planned features that we intend to add to Feature Hunt to enhance functionality and usability.

Dark Mode
Social Account Authorization
Product Owner Dashboard
User Suggestion Statuses
Private Products / Restricted Access
Advanced Search Filters

⚙️ Contributions

Please refer to the Contributing.md if you want to contrbute to the Feature Hunt source code. Follow all the guidelines mentioned and raise a pull request for the developers to review before the code goes to the main source code.

👤 Contributors

Phase 1	_{Raj Shah}	_{Nirav Patel}	_{Parth Kanakiya}	_{Mithil Dave}	_{Bhargav Jethwa}
Phase 2	_{Emily Tracey}	_{Peeyush Taneja}	_{Jonathan Nguyen}	_{Leila Moran}	_{Shraddha Mishra}
Phase 3	_{Suraj Devatha}	_{Sneha Aradhey}	_{Ashwini Nayak}	_{Himanshuu Gupta}	_{Shreyansh Prajapati}
Phase 4	_{Nidhay Pancholi}	_{Aryan Gupta}	_{Lagani Patel}	_{Aditi Verma}
Phase 5	_{Mark Feng}	_{Arjit Agarwan}	_{Sumedh Patkar}	_{Reuben Thomas}

Rubric

Notes	Score	Evidence
X	Video	2min video of new functionality, showing a significant delta from prior.
Workload is spread over the whole team	3	feature-hunt/commits/main, feature-hunt/commits/project3, and feature-hunt/commits/vite-react-port show commits for all members working on different features together
Number of commits	3	feature-hunt/commits/40+ in main (i stopped counting), 24 in feature-hunt/commits/project3, and 13 in feature-hunt/commits/vite-react-port
Number of commits: by different people	3	feature-hunt/commits/main, feature-hunt/commits/project3, and feature-hunt/commits/vite-react-port show multiple commits for all members
Issues reports: there are many	3	https://github.com/Sumedh-Patkar/feature-hunt/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc, many issues have been opened, worked on, and closed
Issues are being closed	3	https://github.com/Sumedh-Patkar/feature-hunt/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed, multiple issues have been finished and closed
DOI badge: exists	3	feature-hunt/tree/main/README.md, Below the banner. 10.5281/zenodo.5759268
X	Docs: doco generated, format not ugly	in GH
X	Docs: what: point descriptions of each class/function (in isolation)
Docs: how: for common use cases X,Y,Z mini-tutorials showing worked examples on how to do X,Y,Z	3	feature-hunt/tree/main/README.md, under the Instructions section
Docs: why: docs tell a story, motivate the whole thing, deliver a punchline that makes you want to rush out and use the thing	3	feature-hunt/tree/main/README.md, The sections Introduction to Contributors tells the story of who Feature Hunt is for, why they should use it, usecases, as well the vision
X	Docs: short video, animated, hosted on your repo. That convinces people why they want to work on your code.
Use of version control tools	3	Version control using Git
x	Use of style checkers	config files in GH showing your config
X	Use of code formatters.	config files in GH showing your this formatter's config
X	Use of syntax checkers.	config files iin GH showing this checker's config
x	Use of code coverage	config files in GH
x	Other automated analysis tools	config files in GH
X	Test cases exist	dozens of tests and those test cases are more than 30% of the code base
X	Test cases are routinely executed	E.g. travis-com.com or github actions or something
X	The files CONTRIBUTING.md lists coding standards and lots of tips on how to extend the system without screwing things up
X	Issues are discussed before they are closed	even if you discuss in slack, need a sumamry statement here
Chat channel: exists	3
X	Test cases: a large proportion of the issues related to handling failing cases.	If a test case fails, open an issue and fix it
Evidence that the whole team is using the same tools: everyone can get to all tools and files	3	feature-hunt/commits/main, feature-hunt/commits/project3, and feature-hunt/commits/vite-react-port show commits for all members implying access to the repo, dependencies installation is automated
Evidence that the whole team is using the same tools (e.g. config files in the repo, updated by lots of different people)	3	feature-hunt/commits/main, feature-hunt/commits/project3, and feature-hunt/commits/vite-react-port show commits for all members over various parts of the code used in the program
Evidence that the whole team is using the same tools (e.g. tutor can ask anyone to share screen, they demonstrate the system running on their computer)	3	All members can run the program
Evidence that the members of the team are working across multiple places in the code base	3	feature-hunt/commits/main, feature-hunt/commits/project3, and feature-hunt/commits/vite-react-port have commits over frontend, backend, and documentation
X	Short release cycles	(hard to see in short projects) project members are committing often enough so that everyone can get your work

sumedh-patkar / feature-hunt Goto Github PK

feature-hunt's Introduction