Vendure is a modern, headless e-commerce platform based on Node.js that allows developers to build custom online stores, marketplaces, and other e-commerce related applications.
In this tutorial, we will walk through the steps to install Vendure on Arch Linux operating system.
Before installing Vendure, you must ensure that Node.js and Yarn package manager are installed on your local machine.
To install Node.js, open the Terminal and execute the following command:
sudo pacman -S nodejs
To verify the installation, run:
node -v
Your terminal should display the installed Node.js version.
To install Yarn, use the pacman package manager:
sudo pacman -S yarn
Verify the installation by running:
yarn --version
Once the prerequisites are installed, you can proceed to install Vendure.
First, create a new directory where you will store the Vendure project:
mkdir my-vendure-store
cd my-vendure-store
Initialize a new Yarn project:
yarn init -y
Now, you can install Vendure using the following command:
yarn add @vendure/core @vendure/admin-ui @vendure/shop-plugin
This command installs the core Vendure package, as well as the Admin UI and the Shop plugin.
After installing Vendure, you need to create a configuration file to customize your Vendure store according to your preferences.
Create a file called vendure-config.ts
in the root of your project directory:
nano vendure-config.ts
Add the following code to the file:
import { config } from '@vendure/core';
export default config({
apiOptions: {
port: 3000,
adminApiPath: 'admin-api',
shopApiPath: 'shop-api',
cors: {
origin: ['http://localhost:4200'],
credentials: true,
},
adminApiPlayground: {
settings: {
'request.credentials': 'include',
},
},
shopApiPlayground: {
settings: {
'request.credentials': 'include',
},
},
},
});
This configuration sets up the API options, such as the port, and specifies the CORS policy to allow requests from localhost:4200
. It also enables the Admin UI and Shop playground.
Press CTRL + X
, then Y
, then ENTER
to save the changes.
Once the configuration file is created, you can start Vendure by running:
yarn vendure start
You should see a message that Vendure is now running on http://localhost:3000/shop-api
and the Admin UI is accessible at http://localhost:3000/admin
.
You have successfully installed Vendure on Arch Linux! Happy e-commerce building!
If you want to self-host in an easy, hands free way, need an external IP address, or simply want your data in your own hands, give IPv6.rs a try!
Alternatively, for the best virtual desktop, try Shells!