hubble PWA Docs
PWA
Demo
Website
Github
PWA
Demo
Website
Github
  • What is hubble PWA?
    • Overview
    • Techstack
    • Requirements
    • Installation
    • Roadmap
    • Contact
    • Troubleshooting
  • Architecture

    • Shop Connector
    • File-based inheritance
    • Pages
    • Preinstalled Modules
    • User Session
    • Layouts
    • Components
  • Configuration
  • Theming

    • Default Theme
  • Shopware 6
    • How to set up Shopware 6 to work with hubble PWA
    • Shopware 6 Plugins
    • Shopware 6 Emotionworlds
    • i18n
    • Trade-offs
  • Module Development
    • Contribution Guide PWA
    • Tests
    • Hubble Coding Guidelines for Contributors
    • API Clients

Contribution Guide PWA

1: Create an issue:
Every change to the code and every pull request must be assigned to an issue. The issue ID created is required for the following steps.

2: Fork the hubble Repository with your Github account.

3: Install dependencies:

npm install

4: Setup hubble for module development:

  • Create .env files in playground and __tests__/module/fixture
  • Run npm run dev:prepare to generate type stubs.
  • Use npm run dev to start the playground in development mode.

5: Test production build:

  • Use npm run prepack to bundle module source code
  • Use npm run dev:build to build the folder playground in production mode
  • Use node playground/.output/server/index.mjs to start node server

6: Tracking the original repository as a remote fork:
This is especially important to keep the fork up to date to the original repository (upstream).

git remote add --track main upstream https://github.com/hubblecommerce/hubble-frontend-pwa.git
git fetch upstream

7: Create a new branch for the issue based on the upstream main branch:

git checkout -b issue#<NUM> upstream/main

8: Push changes to the code to the fork repository (specify issue ID):

git add .
git commit -m "issue#<NUM> my detailed commit message"
git push -u origin issue#<NUM>

9: Create a Pull Request:
Go to Pull Requests. You should see an automatic suggestion from Github to make a new pull request from the created branch issue#<NUM>

Prev
Shopware 6