Feature Hunt
+ Describe. Submit. Behold. +
diff --git a/.gitignore b/.gitignore index 6d7856a..3d9db84 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,4 @@ __pycache__ .idea .coverage .netlify +-idea/ diff --git a/CITATION.md b/CITATION.md new file mode 100644 index 0000000..0112160 --- /dev/null +++ b/CITATION.md @@ -0,0 +1 @@ +[](https://zenodo.org/badge/latestdoi/432041373) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5580bbe..6070b88 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,8 @@ Explain the problem and include additional details to help maintainers reproduce * Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. * If you encounter a bug in a specific branch, please note the branch name. +Use the [Bug_Report Template](https://github.com/Ashnayak/feature-hunt/blob/main/issue_templates/Bug_Report.md) while creating the new bug request. + **Do NOT report a bug on a specific file, line of code, or test case if the file, code, or test case in question is not present anywhere in the repository.** ## Suggesting Enhancements @@ -44,7 +46,7 @@ Enhancement suggestions are tracked as Github issues. After you have determined * Explain why this enhancement would be useful to most users and is not something that can or should be implemented as a community package. * List some other text editors or applications where this enhancement exists. * Specify the name and version of the OS you're using. - +Use the [Feature Request Template](https://github.com/Ashnayak/feature-hunt/blob/main/issue_templates/Feature_Request.md) while creating the new feature request. Alternatively, you can open a new discussion here: https://github.com/CSC510-Group-25/feature-hunt/discussions/categories/ideas diff --git a/README.md b/README.md index 79b8779..801a1a5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
[](https://app.codacy.com/gh/CSC510-Group-25/feature-hunt?utm_source=github.com&utm_medium=referral&utm_content=CSC510-Group-25/feature-hunt&utm_campaign=Badge_Grade_Settings) -[](https://zenodo.org/badge/latestdoi/413987683) +[](https://zenodo.org/badge/latestdoi/432041373) [](https://github.com/shahrk/feature-hunt/blob/main/LICENSE) [](https://www.javascript.com) [](https://github.com/prettier/prettier) @@ -197,6 +197,9 @@ This app has been deployed using Netlify and Heroku. Check it out [here!](https: 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](https://github.com/CSC510-Group-25/feature-hunt/wiki/Deployment:-Heroku-and-Netlify) +## Contributions to the Project +Please refer to the [Contributing.md](https://github.com/Ashnayak/feature-hunt/blob/main/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. + ## Future Scope We believe in the ability to add new features in any project (including our own). @@ -206,7 +209,7 @@ We believe in the ability to add new features in any project (including our own)| Group 27 | +Phase 1 | Raj Shah |
Nirav Patel |
Parth Kanakiya |
@@ -215,11 +218,20 @@ We believe in the ability to add new features in any project (including our own)
||
| Group 25 | +Phase 2 | Emily Tracey |
Peeyush Taneja |
Jonathan Nguyen |
Leila Moran |
Shraddha Mishra |
| Phase 3 | +Suraj Devatha |
+ Sneha Aradhey |
+ Ashwini Nayak |
+ Himanshuu Gupta |
+ Shreyansh Prajapati |
+
+
+ >>>>>>>>>>AUTOGENERATED MAIL<<<<<<<<<<>>>>>>>>>><<<<<<<<<<
+
+
+
+ Hi All,
+
+
+
+
+ """ + html_str1 + """
+
+
+ """
+ HTML_BODY = MIMEText(email_content, 'html')
+ msg.attach(HTML_BODY)
+ server = smtplib.SMTP_SSL("smtp.gmail.com", 465)
+ server.login(username, password)
+ print("Sending...")
+ server.sendmail(emailfrom, recipients, msg.as_string())
+ server.quit()
+ print("Sent")
+ return 'Email Sent!'
diff --git a/docs/ImprovementDoc.md b/docs/ImprovementDoc.md
new file mode 100644
index 0000000..a1abf65
--- /dev/null
+++ b/docs/ImprovementDoc.md
@@ -0,0 +1,39 @@
+## Phase 3 Improvements
+Phase 3 saw many changes in the develpoment of feature-hunt. In this document we provide a detailed overview of all the changes implemented by our team during Phase 3.
+
+## Front End
+The team worked meticulously to improve the user interface. While revamping the existing UI, we took the liberty to add a couple more features:
+- The Phase 2 version did not have a login page
+- The Phase 2 version did not have a signup page.
+
+*Improvements:*
+1) Created a SignUp page to enable new users to create an account to use feature-hunt.
+2) Designed a login page that acts as the portal to sign in once a user has an account (ONLY when a user has an account).
+3) Added Collaborators to the project form. This helps us send email notifications to the collaborators regarding updates related to their project features.
+4) Improved existing UI for displaying projects and features.
+5) Made the user experience more insightful by creating a description feature for each project and feature. A new user can intuitively understand what each project or feature does.
+6) Fixed the Search Bar functionality. Users can now use the search bar to look up Projects easily.
+
+## Back End
+With respect to backend, we decided to use the existing tech stack and improve upon it. We went ahead with using Docker and MongoDB as the previous team had done.
+
+*Improvements:*
+1) Redesigned the schema for feature-hunt
+2) We introduced an email alerting mechanism that notified users with triggered email alerts. The notification is triggered upon the completion of a project close discussion date and informs the user about the five most popular features. There is also an attachment providing more information on all the features discussed as well.
+
+## Comparing Results of Phase 2 and Phase 3
+
+
+Phase 2 | Phase 3
+:-------------------------:|:-------------------------:
+No Signup page | New Signup page
+No Login page | New Login page
+No Search Functionality | Implemented Search Functionality
+Basic Form | Improved Form with Tags and Contributors
+No Project Description | Added Project Description
+
+## Tools used
+The original team used React, JavaScript, Python3, Flask, MongoDB, HTML and CSS. In addition to these, we have used Bootstrap.
+
+## Conclusion of Phase 3
+Working on Phase 3 was an eye-opening simulation of how Software Engineering project development occurs in the real world. Countless brainstorming sessions to whip up a myriad of creative ideas which we brought to fruition, in short, the Phase 3 sojourn was a memorable learning experience. We would like to thank Dr. Timothy Menzies for helping us understand the process of building a good Software Engineering project. We would also like to thank the teaching assistants Xiao Ling, Andre Lustosa, Kewen Peng, Weichen Shi for their support throughout the project. We are grateful for the opportunity to work with our friends and colleagues at NCSU - shout out to the developers of Phase 1 and Phase 2 for their contribution to this amazing project!
diff --git a/docs/Phase3_docs/ImprovementDoc.md b/docs/Phase3_docs/ImprovementDoc.md
new file mode 100644
index 0000000..2af041c
--- /dev/null
+++ b/docs/Phase3_docs/ImprovementDoc.md
@@ -0,0 +1,39 @@
+## Phase 3 Improvements
+Phase 3 saw many changes in the develpoment of feature-hunt. In this document we provide a detailed overview of all the changes implemented by our team during Phase 3.
+
+## Front End
+The team worked meticulously to improve the user interface. While revamping the existing UI, we took the liberty to add a couple more features:
+- The Phase 2 version did not have a login page
+- The Phase 2 version did not have a signup page.
+
+*Improvements:*
+1) Created a SignUp page to enable new users to create an account to use feature-hunt.
+2) Designed a login page that acts as the portal to sign in once a user has an account (ONLY when a user has an account).
+3) Added Collaborators to the project form. This helps us send email notifications to the collaborators regarding updates related to their project features.
+4) Improved existing UI for displaying projects and features.
+5) Made the user experience more insightful by creating a description feature for each project and feature. A new user can intuitively understand what each project or feature does.
+6) Fixed the Search Bar functionality. Users can now use the search bar to look up Projects easily.
+
+## Back End
+With respect to backend, we decided to use the existing tech stack and improve upon it. We went ahead with using Docker and MongoDB as the previous team had done.
+
+*Improvements:*
+1) Redesigned the schema for feature-hunt
+2) We introduced an email alerting mechanism that notified users with triggered email alerts. The notification is triggered upon the completion of a project close discussion date and informs the user about the five most popular features. There is also an attachment providing more information on all the features discussed as well.
+
+## Comparing Results of Phase 2 and Phase 3
+
+
+Phase 2 | Phase 3
+:-------------------------:|:-------------------------:
+No Signup page | New Signup page
+No Login page | New Login page
+No Search Functionality | Implemented Search Functionality
+Basic Form | Improved Form with Tags and Contributors
+No Project Description | Added Project Description
+
+## Tools used
+The original team used React, JavaScript, Python3, Flask, MongoDB, HTML and CSS. In addition to this tech stack, we used Bootstrap for creating the login and sign up page.
+
+## Conclusion of Phase 3
+Working on Phase 3 was an eye-opening simulation of how Software Engineering project development occurs in the real world. Countless brainstorming sessions to whip up a myriad of creative ideas which we brought to fruition, in short, the Phase 3 sojourn was a memorable learning experience. We would like to thank Dr. Timothy Menzies for helping us understand the process of building a good Software Engineering project. We would also like to thank the teaching assistants Xiao Ling, Andre Lustosa, Kewen Peng, Weichen Shi for their support throughout the project. We are grateful for the opportunity to work with our friends and colleagues at NCSU - shout out to the developers of Phase 1 and Phase 2 for their contribution to this amazing project!
diff --git a/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.20 PM (1).jpeg b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.20 PM (1).jpeg
new file mode 100644
index 0000000..9643e83
Binary files /dev/null and b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.20 PM (1).jpeg differ
diff --git a/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.20 PM.jpeg b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.20 PM.jpeg
new file mode 100644
index 0000000..17640d1
Binary files /dev/null and b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.20 PM.jpeg differ
diff --git a/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM (1).jpeg b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM (1).jpeg
new file mode 100644
index 0000000..40be651
Binary files /dev/null and b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM (1).jpeg differ
diff --git a/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM (2).jpeg b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM (2).jpeg
new file mode 100644
index 0000000..200595c
Binary files /dev/null and b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM (2).jpeg differ
diff --git a/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM.jpeg b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM.jpeg
new file mode 100644
index 0000000..a83d1f3
Binary files /dev/null and b/docs/Phase3_docs/screenshots/WhatsApp Image 2021-11-29 at 12.12.21 PM.jpeg differ
diff --git a/issue_templates/Bug_Report.md b/issue_templates/Bug_Report.md
new file mode 100644
index 0000000..cbca49d
--- /dev/null
+++ b/issue_templates/Bug_Report.md
@@ -0,0 +1,30 @@
+# BugReport.md
+
+| Name | About |
+| ------------------- |:---------------------------------------:|
+| Bug Report | Report a bug in the code environment |
+
+
+## Summary
+Description of the issue
+
+## Steps to reproduce
+
+1.
+2.
+3.
+
+**Expected behavior:**
+
+
+**Actual behavior:**
+
+
+**Reproduces how often:**
+
+
+## Version Details
+Please include the tools/languages and the OS version you're running.
+
+## Additional Information
+Any additional information, configuration that might be necessary to reproduce the issue.
diff --git a/issue_templates/Feature_Request.md b/issue_templates/Feature_Request.md
new file mode 100644
index 0000000..56c808c
--- /dev/null
+++ b/issue_templates/Feature_Request.md
@@ -0,0 +1,17 @@
+# FeatureRequest.md
+
+| Name | About |
+| ------------------- |:---------------------------------------:|
+| Feature Request | Suggest an new feature for this project |
+
+
+## Summary
+Summary of the feature
+
+## Motivation
+What is the motivation behind the project?
+What usecases does it support?
+What is the expected outcome?
+
+## Additional context
+Add any other context or screenshots about the feature request here.
diff --git a/src/Components/Feature.js b/src/Components/Feature.js
index b8fc44b..4bed3ef 100644
--- a/src/Components/Feature.js
+++ b/src/Components/Feature.js
@@ -57,6 +57,10 @@ const Feature = ({ features, index, setFeatures, editable }) => {
{capitalizeFirstLetter(features[index].text)}
+
+
+ {capitalizeFirstLetter(features[index].desc || 'No Description Provided')}
+
+ Feature Hunt
+ Describe. Submit. Behold.
+
+
for your favorite Apps!
+ Let's get creative!
+