To start your journey with Storefront, you need to have a working environment. Vue Storefront Solution Engineers will provide you with everything you need to start developing your application.
Unleash the Power of Storefront!
Ready to see Storefront in action? Experience a world of difference firsthand!
Request an exclusive demo now and start building the next generation of eCommerce experiences.
The expected versions of Node.js can be found in the
.nvmrc file. If you're new to this ecosystem, we encourage you to install NVM (Node Version Manager) for easier management of Node versions.
We use Yarn package manager. If you don't have it, please follow the official Yarn installation guide.
Once Vue Storefront Solution Engineers provide you with the access to the repository, you can clone it, initialize and install the dependencies.
yarn run init
This command will intialize the project and install all dependencies for every package in the monorepo and you're ready to go.
To serve the application locally, run:
Depending on your project configuration you should be able to access the applications under following links:
- frontend (Storefront, Next.js)
- frontend (Storefront, Nuxt)
- middleware (API)
Visit the local Storefront link to see your application. You're now ready to start your journey with Storefront."
Each application in the monorepo has its own
package.json file, which contains the
scripts section. Turborepo allows us to run the same command in every package at once.
In the root directory, you can find the
turbo.json file with a list of configured the monorepo commands. In order to run them, check
List of available commands:
lint- run ESLint in every package
format- run Prettier in every package
test:unit- run tests in every package
build- run build command in every package
dev- run development server in every app
dev:next- run development server only with Next.js app
dev:nuxt- run development server only with Nuxt app
If a package doesn't have the appropriate command, Turborepo will skip it.
You've successfully set up your Storefront project and are now ready to start developing your application. Next, learn more about the Storefront architecture.