Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vendure-ecommerce/real-world-vendure
A project showcasing a real-world tooling and plugin setup for a Vendure server
https://github.com/vendure-ecommerce/real-world-vendure
Last synced: 7 days ago
JSON representation
A project showcasing a real-world tooling and plugin setup for a Vendure server
- Host: GitHub
- URL: https://github.com/vendure-ecommerce/real-world-vendure
- Owner: vendure-ecommerce
- Created: 2019-11-22T16:12:48.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T19:12:27.000Z (9 months ago)
- Last Synced: 2024-10-29T20:26:07.529Z (2 months ago)
- Language: TypeScript
- Homepage: https://www.vendure.io
- Size: 8.66 MB
- Stars: 97
- Watchers: 8
- Forks: 56
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Real World Vendure
This project demonstrates a real-world [Vendure](https://www.vendure.io/) server setup. It was generated with [`@vendure/create`](https://github.com/vendure-ecommerce/vendure/tree/master/packages/create), but adds extra tooling and includes some example real-world plugins.
## Getting Started
1. Clone this repo
2. `npm install` to install dependencies
3. `npm run populate` to populate the database with some sample data
4. In the root dir, run `npm run build` to build the application
5. Run `npm run start` to start the Vendure server
6. Login to [`http://localhost:3000/admin/login`](http://localhost:3000/admin/login) with the default [`@vendure/create`](https://www.vendure.io/docs/getting-started/#installation-with-@vendure/create) credentials (username `superadmin`, password `superadmin`).
## Tooling
### [eslint](https://eslint.org/) & [Prettier](https://prettier.io/)
These are tools for finding and fixing common code issues and formatting your code in a standard way. Run `npm run lint:fix` to lint and format your code.
### [vitest](https://vitest.dev/)
Vitest is a testing framework used in the plugin end-to-end tests. Testing in Vendure is covered in our [testing guide](https://docs.vendure.io/developer-guide/testing/).
End-to-end tests for the reviews plugin are run with `npm run e2e:reviews`
### [graphql-code-generator](https://graphql-code-generator.com/)
This is used to generate TypeScript types based on the Vendure server's GraphQL APIs. It is used to automatically generate correct types for plugin resolvers and plugin e2e tests. This ensures that whenever a schema is changed or a CustomField added, new typings can be generated to make sure your resolvers and tests are correct.
Whenever a change to the GraphQL API is made either by a plugin schema extension or by the definition of CustomFields, run `yarn codegen` to update the TypeScript definitions (make sure the server is running locally at the same time).
## Plugins
### Reviews Plugin
This plugin adds the capability for customers to create product reviews which can then be used to display product ratings.
The plugin showcases several advanced capabilities of the Vendure plugin system. See the [reviews plugin readme](./src/plugins/reviews/README.md) for more information.
## UI Extensions
This repo also demonstrates approaches to extending the Admin UI:
* Angular-based ui extensions in the [reviews plugin](./src/plugins/reviews/ui)
* A Vue-based, [uncompiled ui extension](./src/ui-extensions/vue-app)
## Directory structure
* `/src` contains the source code of your Vendure server. All your custom code and plugins should reside here.
* `/static` contains static (non-code) files such as assets (e.g. uploaded images) and email templates.
* `/migrations` contains database migration scripts (see migrations section below).
## Development
```
npm run start
```
will start the Vendure server and [worker](https://www.vendure.io/docs/developer-guide/vendure-worker/) processes from
the `src` directory. Note - the first time you run this the custom UI extensions of the reviews plugin will be compiled which may take a few minutes. Subsequent runs will be much faster (providing the UI extensions of the reviews plugin do not change).
## Build & deploy
```
npm run build
```
will compile the TypeScript sources into the `/dist` directory and compile the custom Admin UI app into the `/admin-ui` directory.
Then to run in production, the files `/dist/index.js` & `/dist/index-worker.js` should be run in Node.
## Migrations
[Migrations](https://www.vendure.io/docs/developer-guide/migrations/) allow safe updates to the database schema.
To create a new migration, run:
```
npx vendure migrate
```