Merge pull request #2 from amansinghbais/1-basic-structure

Implemented: basic structure of the app (#1)

.browserslistrc

@@ -0,0 +1,3 @@
+> 1%
+last 2 versions
+not dead

.env.example

@@ -0,0 +1,6 @@
+VUE_APP_I18N_LOCALE=en
+VUE_APP_I18N_FALLBACK_LOCALE=en
+VUE_APP_CACHE_MAX_AGE=3600
+VUE_APP_VIEW_SIZE=10
+VUE_APP_PERMISSION_ID=
+VUE_APP_DEFAULT_LOG_LEVEL="error"

.eslintrc.js

@@ -0,0 +1,22 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true
+  },
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/typescript/recommended'
+  ],
+  parserOptions: {
+    ecmaVersion: 2020,
+    parser: '@typescript-eslint/parser'
+  },
+  rules: {
+    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
+    'vue/no-deprecated-slot-attribute': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    'vue/multi-word-component-names' : 'off'
+  }
+}

.firebaserc

@@ -0,0 +1,30 @@
+{
+  "projects": {
+    "default": "hotwax-digital-commerce",
+    "uat": "hotwax-digital-commerce-uat",
+    "production": "digital-commerce-71eb8"
+  },
+  "targets": {
+    "hotwax-digital-commerce": {
+      "hosting": {
+        "dev": [
+          "company-dev"
+        ]
+      }
+    },
+    "hotwax-digital-commerce-uat": {
+      "hosting": {
+        "uat": [
+          "company-uat"
+        ]
+      }
+    },
+    "digital-commerce-71eb8": {
+      "hosting": {
+        "prod": [
+          "company"
+        ]
+      }
+    }
+  }
+}

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: 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,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+labels: enhancement
+
+---
+
+## 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,17 @@
+### 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 -->
+
+
+### Contribution and Currently Important Rules Acceptance
+<!-- Please get familiar with following info -->
+
+- [ ] I read and followed [contribution rules](https://github.com/hotwax/company#contribution-guideline)

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

@@ -0,0 +1,16 @@
+# 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:
+  call-workflow-in-another-repo:
+    uses: hotwax/dxp-components/.github/workflows/common-firebase-hosting-merge.yml@main
+    with:
+      config-path: .github/labeler.yml
+    secrets:
+      envPAT: ${{ secrets.envPAT }}
+      HOTWAX_PUBLIC_SECRET: ${{ secrets.HOTWAX_PUBLIC_SECRET }}

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

@@ -0,0 +1,37 @@
+# Not using the common release workflow file from dxp, as for this app we are using a different project for hosting the uat env
+
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on release
+'on':
+  push:
+    tags:        
+      - '*' # Push events to every tag not containing / Refer https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#patterns-to-match-branches-and-tags
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+            node-version: 18
+      - name: Checkout to latest release tag
+        run: |
+            git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
+      - 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 uat --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:uat
+        env:
+          HOTWAX_PUBLIC_SECRET: ${{ secrets.HOTWAX_PUBLIC_SECRET }}

.github/workflows/pull-request.yml

@@ -0,0 +1,16 @@
+name: Verify build
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+
+jobs:
+  call-workflow-in-another-repo:
+    uses: hotwax/dxp-components/.github/workflows/common-pull-request.yml@main
+    with:
+      config-path: .github/labeler.yml
+    secrets:
+      envPAT: ${{ secrets.envPAT }}

.gitignore

@@ -0,0 +1,35 @@
+# Specifies intentionally untracked files to ignore when using Git
+# http://git-scm.com/docs/gitignore
+
+*~
+*.sw[mnpcod]
+.tmp
+*.tmp
+*.tmp.*
+*.sublime-project
+*.sublime-workspace
+.DS_Store
+Thumbs.db
+UserInterfaceState.xcuserstate
+$RECYCLE.BIN/
+
+*.log
+log.txt
+npm-debug.log*
+
+/.idea
+/.ionic
+/.sass-cache
+/.sourcemaps
+/.versions
+/.vscode
+/coverage
+/dist
+/node_modules
+/platforms
+/plugins
+/www
+
+.env
+.env.*
+!.env.example

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# 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/company/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: **company/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/company/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 be 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.