Have a look at Phase3-Video
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 🎯.
The following technologies were used for the development of this project:
React (P.S. we use hooks)
JavaScript
Python3
Flask
MongoDB
HTML
CSS
We have started using [MaterialUI] for styled components.
For more information, visit our wiki page on tools, hooks, and services.
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)
You can now create an account and mange the products you are a part of! This includes -
Project Submittal - You can instantly add new products to be reviewed by the community.
Tag Management - You can now give feature feedback though tags. Want to say that you are working on a feature? Add a IN DEVELOPMENT tag!
We have fixed various bugs in the Project and we have also added new features. To know more details please check our Delta Document
Before you get started, if you are using Windows, please visit our wiki page on Windows development.
There are two ways to install and develop for featurehunt
-
Using Docker
-
Using Local machine
https://docs.docker.com/get-docker
git clone https://github.com/elric97/feature-hunt.git
cd feature-hunt
docker-compose up --build (This is only needed when you're running the project for the first time. Upon building once, you can run this command without providing --build option)
This will run two docker containers. The frontend will run on port 3000 and the backend will run on port 5000
git clone https://github.com/elric97/feature-hunt.git
cd feature-hunt
Optional: In the project directory run
git config --local core.hooksPath hooksto make sure you have access to the Git Hooks. Run the following commands in order:
Installs the dependencies for the React App
Installs the requirements for the Flask API
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.
To run backend flask api in development mode:
export DB_PATH='Your mongoDb connection URL'
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
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.
You can also connect to the database from your shell using mongosh
Connecting with DB - We have introduced an environment variable DB_PATH, make sure that you set it to your local or deployed environment
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Applies Prettier to all .js files.
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!
We used Heroku and Netlify for deploying the application. We have deployed our application's front end you can check it out here , the application's backend can be found here.
Check out our wiki page to understand how to deploy the application.
We believe in the ability to add new features in any project (including our own).
