Giter Club home page Giter Club logo

hubble-frontend-pwa's Introduction

PWA for headless e-commerce

High performant, intuitive and easy to develop progressive web app to connect with the api of your e-commerce systems API based on Nuxt.js.

GitHub package.json version GitHub contributors PWA Shields

✔ Integrated to Shopware 6 and possible with Magento, Magento 2, xt:Commerce, etc.
✔ Contains all common pagetypes like: Category, Product Detail, Cart, Checkout, Customer Account, ...)
✔ Excellent Google Lighthouse results in all audits
✔ Toolbox / Boilerplate to create your own frontend

Contribution Guide PWA

1: Create 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 des hubble Repositorys auf eigenen Github Account erstellen.

3: Setup NuxtJs

npx create-nuxt-app <PROJECT-NAME>

4: Clone new fork

cd <PROJECT-NAME>
mkdir modules
cd modules
git clone https://github.com/<YOUR-ACCOUNT-NAME>/hubble-frontend-pwa.git

5: Register module to nuxtjs

// ~/package.json
"devDependencies": { 
    "@hubblecommerce/hubble": "file:modules/hubble-frontend-pwa/@hubblecommerce/hubble"
}
// ~/nuxt.config.js
buildModules: [
    ['@hubblecommerce/hubble']
]

6: Install dependencies

npm install

7: Edit configs in .env file

# API
# Define api type:
# possible source parameters are:
# api = hubble Api based on elastic search
# sw = official Shopware 6 API (headless Channel)
API_TYPE          = 'sw | api'
API_SW_ACCESS_KEY = ''
API_BASE_URL      = ''

8: Install dependencies and launch app in dev mode

npm install
npm run dev

9: 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 master upstream https://github.com/hubblecommerce/hubble-frontend-pwa.git
git fetch upstream

10: Create a new branch for the issue based on the upstream master branch

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

11: 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>

12: Pull Request
Visit Pull requests von hubble. You should se an automatic suggestion from Github to make a new pull request from the created branch issue#<NUM>.
Important! Specify dev as base branch and NOT master.

Release History

  • 1.3.0
    • Refactored app to improve performance
  • 1.2.0
    • Specified API to Shopware 6 store-api
  • 1.1.0
    • Extracted the hubble core to nuxt module
  • 1.0.0
    • The first proper release

Meta

digital.manufaktur GmbH – [email protected]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/hubblecommerce/hubble-frontend-pwa

Contributing

Detailed instructions to do pull requests can be found here: hubble Contribution Guide

hubble-frontend-pwa's People

Contributors

annakoehler avatar dally-dally avatar dm-heinze avatar dm-neslihan avatar gar-nele avatar mpkix avatar philipp12345 avatar sebastianmaurer avatar zermoran avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.