https://github.com/vuestorefront-community/vendure

Vue Storefront 2 integration for Vendure
https://github.com/vuestorefront-community/vendure

graphql nestjs nuxt vendure vue vue-storefront

Last synced: about 8 hours ago
JSON representation

Vue Storefront 2 integration for Vendure

• Host: GitHub
• URL: https://github.com/vuestorefront-community/vendure
• Owner: vuestorefront-community
• License: mit
• Created: 2021-03-24T10:21:07.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-01-29T22:49:46.000Z (10 months ago)
• Last Synced: 2024-05-22T16:33:05.786Z (6 months ago)
• Topics: graphql, nestjs, nuxt, vendure, vue, vue-storefront
• Language: TypeScript
• Homepage: https://docs.vuestorefront.io/vendure/
• Size: 3.71 MB
• Stars: 70
• Watchers: 15
• Forks: 50
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-vuestorefront - Repository

README

        


  

  



### Stay connected

[![GitHub Repo stars](https://img.shields.io/github/stars/vuestorefront/vue-storefront?style=social)](https://github.com/vuestorefront/vue-storefront)

[![Twitter Follow](https://img.shields.io/twitter/follow/vuestorefront?style=social)](https://twitter.com/vuestorefront)

[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCkm1F3Cglty3CE1QwKQUhhg?style=social)](https://www.youtube.com/c/VueStorefront)

[![Discord](https://img.shields.io/discord/770285988244750366?label=join%20discord&logo=Discord&logoColor=white)](https://discord.vuestorefront.io)

## Vue Storefront 2 integration with Vendure

This project is a Vendure integration for [Vue Storefront 2](https://github.com/vuestorefront/vue-storefront/).

## How to start if you want to try out the integration

```bash

yarn global add @vue-storefront/cli

```

```bash

vsf init 

```

Choose `Vendure` or use `Custom template from Github` option and type: `https://github.com/vuestorefront/template-vendure.git`.

```bash

cd  

```

```bash

yarn

```

```bash

yarn dev

```

## How to start if you want to contribute?

Want to contribute? Ping us on `vendure` channel on [our Discord](https://discord.vuestorefront.io)!

### Requirements

- NodeJS v14 or later

- Vendure server running in localhost for GraphQL API or 

- Set up auth options in Vendure server (This functionality is available for those who scaffold a local instance of Vendure)

```ts

// vendure-config.ts

...

  authOptions: {

    tokenMethod: 'bearer', // authorization header method

    requireVerification: false, // disable register by email verification

  },

```

### Setting up Vendure Server

### Steps

1. Fork the repo

2. Clone your fork of the repo

    ```bash

    git clone https://github.com/vuestorefront/vendure.git

    cd vendure

    ```

3. Run `yarn` to install dependencies

4. Add your Vendure server GraphQL API uri to env file in `packages/api-client` and `packages/theme`

    ```bash

    cd packages/theme

    cp .env.example .env

    ```

    ```js

    // packages/theme/.env.example

    GRAPHQL_API=http://localhost:3000/shop-api

    TOKEN_METHOD=bearer

    ```

    These environment variables will be then used in:

    ```js

    // packages/theme/middleware.config.js

    module.exports = {

      integrations: {

        vendure: {

          location: '@vue-storefront/vendure-api/server',

          configuration: {

            api: {

              uri: process.env.GRAPHQL_API,

              tokenMethod: process.env.TOKEN_METHOD

            },

          }

        }

      }

    };

    ```

5. Build dependencies `yarn build`

6. Run `yarn dev` to run theme. You can find other commands in `package.json`

Your project will be running on `http://localhost:3001` (As Vendure server is running on port `3000`)

## Resources

- [Vue Storefront Documentation](https://docs.vuestorefront.io/v2/)

- [Vendure integration Documentation](https://docs.vuestorefront.io/vendure)

- [Vendure Documentation](https://www.vendure.io/docs/)

- [Community Chat](https://discord.vuestorefront.io)

## Support

If you have any questions about this integration we will be happy to answer them on  `vendure` channel on [our Discord](discord.vuestorefront.io).

## Contributors ✨

Thanks go to these wonderful people 🙌:

  

    
Jakub Andrzejewski
💻 🚧 📆 📖

    
Rafael Garcia Lepper
💻

    
Michael Bromley
👀

    
Filip Jędrasik
👀

    
Mateusz Pietrusiński
👀

  

  

    
igorwojciechowski
⚠️

    
Heitor Ramon Ribeiro
🧑‍🏫

    
Milan Zivkovic
💻

    
[email protected]
💻

    
Justyna
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!