Stay connected
Vue Storefront 2 integration with Vendure
This project is a Vendure integration for Vue Storefront 2.
How to start if you want to try out the integration
yarn global add @vue-storefront/cli
vsf init <project_name>
Choose Vendure
or use Custom template from Github
option and type: https://github.com/vuestorefront/template-vendure.git
.
cd <project_name>
yarn
yarn dev
How to start if you want to contribute?
Want to contribute? Ping us on vendure
channel on our Discord!
Requirements
- NodeJS v14 or later
- Vendure server running in localhost for GraphQL API or https://demo.vendure.io/shop-api
- Set up auth options in Vendure server (This functionality is available for those who scaffold a local instance of Vendure)
// vendure-config.ts
...
authOptions: {
tokenMethod: 'bearer', // authorization header method
requireVerification: false, // disable register by email verification
},
Setting up Vendure Server
https://www.vendure.io/docs/getting-started/
Steps
-
Fork the repo
-
Clone your fork of the repo
git clone https://github.com/vuestorefront/vendure.git cd vendure
-
Run
yarn
to install dependencies -
Add your Vendure server GraphQL API uri to env file in
packages/api-client
andpackages/theme
cd packages/theme cp .env.example .env
// packages/theme/.env.example GRAPHQL_API=http://localhost:3000/shop-api TOKEN_METHOD=bearer
These environment variables will be then used in:
// 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 }, } } } };
-
Build dependencies
yarn build
-
Run
yarn dev
to run theme. You can find other commands inpackage.json
Your project will be running on http://localhost:3001
(As Vendure server is running on port 3000
)
Resources
Support
If you have any questions about this integration we will be happy to answer them on vendure
channel on our Discord.
Contributors โจ
Thanks go to these wonderful people ๐:
This project follows the all-contributors specification. Contributions of any kind welcome!