Updated Readme file and added pull request template(#2q9nxqt)

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+labels: bug
+
+---
+
+## Current behavior
+<!--  Describe the current behavior pointing exactly why it's not working as intended. -->
+
+
+## Expected behavior
+<!-- Describe what the desired behavior should be. -->
+
+
+## Steps to reproduce the issue
+<!-- Please provide the steps to reproduce and if possible a *minimal reproducible example* of the problem -->
+
+
+## Can you handle fixing this bug by yourself?
+
+- [ ] YES
+- [ ] NO
+
+## Environment details
+<!-- Please provide all the informations required below. -->
+- Browser: <!-- Your browser, version -->
+- OS: <!-- Your operating system, version -->
+- Code Version: <!-- Tag, branch or commit determining which version of code is used -->
+
+## Additional information
+<!-- If you think that any additional information would be useful, please provide them here. -->
+

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+labels: feature request
+
+---
+
+## What is the motivation for adding/enhancing this feature?
+<!-- Describe the motivation or the concrete use case for a new feature or why one of the current ones should be enhanced. -->
+
+
+## What are the acceptance criteria?
+<!-- List the acceptance criteria for this task in the form of a list. -->
+
+- [ ] ...
+
+## Can you complete this feature request by yourself?
+
+- [ ] YES
+- [ ] NO
+
+## Additional information
+<!-- If you think that any additional information would be useful, please provide them here. -->
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+### Related Issues
+<!--  Put related issue number which this PR is closing. For example #123 -->
+
+Closes #
+
+### Short Description and Why It's Useful
+<!-- Describe in a few words what is this Pull Request changing and why it's useful -->
+
+
+### Screenshots of Visual Changes before/after (If There Are Any)
+<!-- If you made any changes in the UI layer, please provide before/after screenshots -->
+
+
+**IMPORTANT NOTICE** - Remember to update `CHANGELOG.md` with description of your change
+
+
+### Contribution and Currently Important Rules Acceptance
+<!-- Please get familiar with following info -->
+
+- [ ] I read and followed [contribution rules](https://github.com/DivanteLtd/vsf-capybara/blob/master/CONTRIBUTING.md)

.github/workflows/firebase-hosting-merge.yml

@@ -0,0 +1,29 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+'on':
+  push:
+    branches:
+      - main
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: npm install
+      - name: Generate .env file
+        run: cp .env.example .env
+      - name: Build
+        run: npm run build
+      - name: Install Firebase
+        run: npm install -g firebase-tools
+      - name: Set Firebase project
+        run: firebase use default --token "$HOTWAX_PUBLIC_SECRET"
+        env:
+          HOTWAX_PUBLIC_SECRET: ${{ secrets.HOTWAX_PUBLIC_SECRET }}
+      - name: Deploy
+        run: firebase deploy --token "$HOTWAX_PUBLIC_SECRET" -m "Deploying via GitHub actions"  --only hosting:dev-hotwax-shopify-admin-helper
+        env:
+          HOTWAX_PUBLIC_SECRET: ${{ secrets.HOTWAX_PUBLIC_SECRET }}

.github/workflows/pull-request.yml

@@ -0,0 +1,19 @@
+name: Run build tests
+
+'on':  
+  push:
+  pull_request:
+    branches:
+      - master
+
+jobs:  
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install Dependencies
+      run: npm install
+    - name: Generate .env file
+      run: cp .env.example .env
+    - name: Build
+      run: npm run build

README.md

@@ -1,2 +1,93 @@
-# shopify-admin-helper
-shopify-admin-helper
+# Prerequisite
+Ionic CLI - If you don't have the ionic CLI installed refer [official documentation](https://ionicframework.com/docs/intro/cli) for the installation instructions.
+
+# Build Notes (Users)
+
+1. Download the app from [release](https://github.com/hotwax/shopify-admin-helper/releases) page and extract it.
+2. Go to the app directory.
+3. Run following command to download dependencies 
+`npm i
+4. Create a `.env` file by taking reference from the `.env.example`.
+5. To run the app in browser use the command: `ionic serve`
+
+# Build Notes (Contributors)
+
+1. Open a Terminal window
+2. Clone app using the command: `https://github.com/hotwax/shopify-admin-helper.git <repository-name>`
+3. Go to the <repository-name> directory using command: `cd <repository-name>`
+4. Run following command to download dependencies
+`npm i`
+5. Create a `.env` file by taking reference from the `.env.example`.
+6. To run the app in browser use the command: `ionic serve`
+
+# Firebase Hosting
+
+We are using firebase hosting for the Shopify admin helper app deployment
+Here are the steps to deploy app on firebase hosting
+
+## Prerequisite
+
+- [Firebase Cli](https://firebase.google.com/docs/cli) should be installed
+- Firebase project should be created
+- You should have access to firebase project
+
+## Dev deployment
+
+- Update the DEV instance url at .env.production file
+
+- Build the application using following command
+`ionic build`
+
+- Login into firebase
+`firebase login`
+
+- Run following command to deploy to firebase hosting
+`firebase deploy --only hosting:<hosting url>`
+
+## How to build application in different environment or modes(staging, production, qa, etc)?
+
+As there is a bug in Ionic cli due to which we cannot pass flag variables for commands (See [#4669](https://github.com/ionic-team/ionic-cli/issues/4642)). To build application in different modes we need to use vue-cli-service to build and then use the built app using capacitor copy command further.
+
+Follow following instructions:
+
+1. Manually build the application using vue-cli-service:
+npx vue-cli-service build --mode=sandbox
+
+2. Copy web assets to the native project without building the app:
+ionic capacitor copy ios --no-build
+
+3. Open the Android Studio / XCode project:
+ionic capacitor open android 
+ionic capacitor open ios
+
+# Contribution Guideline
+
+1. Fork the repository and clone it locally from the `main` branch. Before starting your work make sure it's up to date with current `main` branch.
+2. Pick an issue from [here](https://github.com/hotwax/shopify-admin-helper/issues). Write in the issue comment that you want to pick it, if you can't assign yourself. **Please stay assigned to one issue at a time to not block others**.
+3. Create a branch for your edits. Use the following branch naming conventions: **shopify-admin-helper/issue-number**.
+4. Please add issue number to your commit message.
+5. Propose a Pull Request to `main` branch containing issue number and issue title.
+6. Use [Pull Request template](https://github.com/hotwax/preorder/blob/main/.github/PULL_REQUEST_TEMPLATE.md) (it's automatically added to each PR) and fill as much fields as possible to describe your solution.
+7. Reference any relevant issues or other information in your PR.
+8. Wait for review and adjust your PR according to it.
+9. Congrats! Your PR should now me merged in!
+
+If you can't handle some parts of the issue then please ask for help in the comment. If you have any problems during the implementation of some complex issue, feel free to implement just a part of it.
+
+## Report a bug or request a feature
+
+Always define the type of issue:
+* Bug report
+* Feature request
+
+While writing issues, please be as specific as possible. All requests regarding support with implementation or application setup should be sent to.
+# UI / UX Resources
+You may find some useful resources for improving the UI / UX of the app <a href="https://www.figma.com/file/bVPRRw282CqGKMdbz7dciH/HC-Ionic-design-system?node-id=15226%3A38906" target="_blank">here</a>.
+
+# Join the community on Discord
+If you have any questions or ideas feel free to join our <a href="https://discord.gg/SwpJnpdyg3" target="_blank">Discord channel</a>
+# The license
+
+Pre-order app is completely free and released under the Apache v2.0 License. Check <a href="https://github.com/hotwax/shopify-admin-helper/blob/main/LICENSE" target="_blank">LICENSE</a> for more details.
+
+