Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/druxt/commerce.demo.druxtjs.org

Prototype: Druxt + Commerce Kickstart
https://github.com/druxt/commerce.demo.druxtjs.org

commerce drupal druxt

Last synced: 24 days ago
JSON representation

Prototype: Druxt + Commerce Kickstart

Awesome Lists containing this project

README

        

# Prototype: Druxt + Commerce Kickstart

> This is in active development, use at your own risk.

This prototype connects a Druxt Nuxt frontend to the Centaro Commerce Kickstart project with the intention of test Druxt as a Fully decoupled commerce solution.

## Quickstart

Try it before you fork it:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Decipher/demo-druxt-commerce)

## Getting started

1. Click the **Use this template** button in GitHub and follow the on-screen instructions to **Create a new repository**.

2. Once the repository has been generated, open it in Gitpod by appending `https://gitpod.io#` to the GitHub url.

Example: `https://gitpod.io#github.com/Decipher/demo-druxt-commerce`

_Note:_ If this is your first time using Gitpod, you can signup for a free plan with your Github account.

3. Wait for your codebase to build.

_Note:_ To speed up this step, enable Prebuilds by follow the instructions @ https://www.gitpod.io/docs/prebuilds#enable-prebuilt-workspaces

## How to use it

Your environment contains a pre-install, pre-configured and running instance of Commerce Kickstart with demonstration content, and Nuxt with the DruxtSite module enabled.

You can access the services in your browser, via the **Remote Explorer** extension, or via the URL pattern: `https://[PORT]-[GITPOD_ID].[GITPOD_SERVER].gitpod.io`

## Services

| Port | Service |
| -- | -- |
| `3000` | Nuxt.js |
| `3003` | Storybook |
| `8080` | Drupal |

## Tools

### DDEV

> DDEV is an open source tool that makes it dead simple to get local PHP development environments up and running within minutes.

DDEV is used to manage the Drupal instance, and provides a CLI that can be used to run common drupal tasks, including `ddev drush`.

These commands should be run from within the `/drupal` folder.

Refer to the documentation for more details: https://ddev.readthedocs.io

### @nuxtjs/storybook

> Storybook integration with NuxtJS .

Druxt integrates with the Nuxt Storybook module to provide zero-configuration, auto-discovery stories with access to live data from your Drupal backend.

To start Storybook, navigate to the `nuxt` directory and run `npx nuxt storybook`.

## License

[MIT](https://github.com/druxt/druxt.js/blob/develop/LICENSE)