docs: update README with installation and feature details

.all-contributorsrc

@@ -14,6 +14,15 @@
         "code"
       ]
     },
+    {
+      "login": "Hardik0307",
+      "name": "Hardik Bagada",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/41434099?v=4",
+      "profile": "https://github.com/Hardik0307",
+      "contributions": [
+        "code"
+      ]
+    },
     {
       "login": "antonkomarev",
       "name": "Anton Komarev",
@@ -22,6 +31,61 @@
       "contributions": [
         "plugin"
       ]
+    },
+    {
+      "login": "KKVANONYMOUS",
+      "name": "Kunal Kumar Verma",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/58628586?v=4",
+      "profile": "https://kkvanonymous.github.io/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "jaideepghosh",
+      "name": "Jaideep Ghosh",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/3909648?v=4",
+      "profile": "http://jaideepghosh.blogspot.com",
+      "contributions": [
+        "code"
+      ]
+    }
+    {
+      "login": "YashKandalkar",
+      "name": "yash",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/35102959?v=4",
+      "profile": "http://yashkandalkar.github.io",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "abhijit-hota",
+      "name": "Abhijit Hota",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/8116174?v=4",
+      "profile": "https://github.com/abhijit-hota",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "Maddoxx88",
+      "name": "Sunit Shirke",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/34238672?v=4",
+      "profile": "https://maddoxx88.github.io/",
+      "contributions": [
+        "code"
+      ]
+    }
+    {
+      "login": "g-savitha",
+      "name": "Savitha Gollamudi",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/31612459?v=4",
+      "profile": "https://www.gsavitha.in",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.eslintignore

@@ -0,0 +1 @@
+node_modules/**

.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["plugin:react/recommended", "airbnb", "prettier"],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["react"],
+  "rules": {
+    "react/forbid-prop-types": 0
+  },
+  "ignorePatterns": ["**/*.test.js"]
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,9 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ""
+title: ''
 labels: bug
-assignees: ""
+assignees: ''
 ---
 
 **Describe the bug**
@@ -40,4 +40,9 @@ If applicable, add screenshots to help explain your problem.
 Add any other context about the problem here.
 
 Join the **Discord Server** for further discussions.
+
+<a href="https://discord.gg/HHMs7Eg">
+<img src="https://discord.com/assets/e4923594e694a21542a489471ecffa50.svg" alt="GPRG Discord Server Link" width="300px"/>
+</a>
+
 Server Link: https://discord.gg/HHMs7Eg

.github/ISSUE_TEMPLATE/feature-enhancement-request.md

@@ -1,9 +1,9 @@
 ---
 name: Feature/Enhancement request
 about: Suggest an idea for this project
-title: ""
-labels: enhancement
-assignees: ""
+title: ''
+labels: enhancement, hacktoberfest
+assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
@@ -20,4 +20,8 @@ Add any other context or screenshots about the feature request here.
 
 Join the **Discord Server** for further discussions.
 
+<a href="https://discord.gg/HHMs7Eg">
+<img src="https://discord.com/assets/e4923594e694a21542a489471ecffa50.svg" alt="GPRG Discord Server Link" width="300px"/>
+</a>
+
 Server Link: https://discord.gg/HHMs7Eg

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,42 @@
+<!--
+     For Work In Progress Pull Requests, please use the Draft PR feature,
+     see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
+
+     For a timely review/response, please avoid force-pushing additional
+     commits if your PR already received reviews or comments.
+
+     Before submitting a Pull Request, please ensure you've done the following:
+     - 📖 Read the Contributing Guide: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CONTRIBUTING.md#create-a-pull-request.
+     - 📖 Read the Code of Conduct: https://github.com/rahuldkjain/github-profile-readme-generator/blob/master/CODE_OF_CONDUCT.md.
+     - 👷‍♀️ Create small PRs. In most cases this will be possible.
+     - ✅ Provide issue number with link.
+     - 📝 Use descriptive commit messages.
+     - 📗 Update any related documentation and include any relevant screenshots.
+-->
+
+## What type of PR is this? (check all applicable)
+
+- [ ] Refactor
+- [ ] Feature
+- [ ] Bug Fix
+- [ ] Enhancement
+- [ ] Documentation Update
+
+## Description
+
+## Related Tickets & Documents
+
+## QA Instructions, Screenshots, Recordings
+
+_Please replace this line with instructions on how to test your changes, as well
+as any relevant images for UI changes._
+
+<!-- ## Added tests?
+
+- [ ] yes
+- [ ] no, because they aren't needed
+- [ ] no, because I need help -->
+
+## Added to documentation?
+
+- [ ] readme

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged

.prettierrc

@@ -1,4 +1,9 @@
 {
-  "arrowParens": "avoid",
-  "semi": false
+  "singleQuote": true,
+  "jsxSingleQuote": false,
+  "tabWidth": 2,
+  "printWidth": 120,
+  "trailingComma": "all",
+  "semi": true,
+  "exclude": ["node_modules", "codepipeline"]
 }

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "14"
+cache:
+  directories:
+    - "node_modules"

CODE_OF_CONDUCT.md

@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

CODE_STYLE_GUIDE.md

@@ -0,0 +1,99 @@
+# Coding Style
+
+## File Layout (`src/components/*.js`)
+
+1. Imports
+2. Reusable components needed for the main component
+3. Main component (Eg: Addons in addons.js)
+4. export default \<MainComponent\>;
+
+## Reusable components
+
+- Do not make a new file for smaller components.
+- Smaller, reusable components needed in the main components should be added **above** the main component, **not** inside it.
+- Use ES6 arrow functions for defining components.
+
+## Spacing
+
+1. **JS:**
+
+   - Use a space after `if`, `for`, `while`, `switch`.
+   - Do not use a space after the opening `(` and before the closing `)`.
+   - Use a space before and after destructuring objects.
+
+   ```js
+   //good
+   const { apple, mangoes } = fruits;
+
+   //bad
+   const { apple, mangoes } = fruits;
+   ```
+
+
+        //Same for destructuring props:
+        //good
+        const BeautifulComponent = ({ prop1, prop2 }) => {}
+
+        //bad
+        const UglyComponent = ({prop1, prop2}) => {}
+    ```
+
+2. **JSX:**
+
+   - Use a space before the forward slash (`/`) of a self-closing tag
+
+   ```js
+   //good
+   <Foo />
+
+   //bad
+   <Foo/>
+   ```
+
+   - Do **not** use spaces for JSX curly braces
+
+   ```js
+   //good
+   <Foo bar={baz} />
+
+   //bad
+   <Foo bar={ baz } />
+   ```
+
+## **Props:**
+
+- Use camelCase for prop names, or PascalCase if the prop value is a React component.
+- Use new lines when props do not fit on the same line.
+
+  ```js
+  //good
+  <Foo
+      prop1={value1}
+      prop2={value2}
+      prop3={value3}
+  />
+
+  //bad
+  <Foo prop1={value1} prop2={value2} prop3={value3} />
+  ```
+
+## **Best practices:**
+
+- **Always** add semicolons after a line.
+- Use ES6 arrow functions.
+- Keep the indentation in your code correct.
+- Use 4 spaces for tabs.
+- Don't Repeat Yourself. If you think you're repeating too much code, make a smaller component, or a function.
+- **Always** add alt prop to `img` tags.
+- Add `rel="noopener"` for `a` tags which has `target="_blank"`.
+- Don't do `outline: none` on user input elements. If you do not want outline, give them faint, visible background on focus. This is for accessibility.
+
+### Other things to note
+
+- We are using [octicons](https://primer.style/octicons/) for icons. Use this if you need to add icons. Do **not** add a new library for icons.
+- Try to not commit changes in `package.json`, `package-lock.json`.
+- Discuss with contributors on discord if you're planning to add/remove a package.
+
+## Further reading:
+
+This guide is based on [airbnb's react guide](https://github.com/airbnb/javascript/tree/master/react). You can read all the best practices there.