Environment Setup

Selldone Storefront Environment Setup Guide

This guide provides step-by-step instructions on setting up your environment to build and run the Selldone Storefront Vue project. Follow these steps for Windows, Linux, macOS, and Ubuntu to ensure a smooth setup from zero to running yarn serve.

Prerequisites

Before you begin, ensure you have administrative access to your computer and a stable internet connection for downloading necessary software.

Step 1: Install Node.js

Node.js is essential for running JavaScript on the server.

Windows & macOS

  1. Download the installer for Windows or macOS.

  2. Run the installer and follow the prompts to install Node.js.

Linux/Ubuntu

For Linux, particularly Ubuntu, you can install Node.js via the package manager:

sudo apt update
sudo apt install nodejs
sudo apt install npm

Step 2: Install Yarn

Yarn is a package manager that doubles as project manager.

Windows

For Windows, you can install Yarn through the installer:

  1. Download and run the Yarn installer.

macOS

On macOS, you can use Homebrew:

brew install yarn

Linux/Ubuntu

For Ubuntu and other Linux distributions:

npm install --global yarn

Step 3: Clone Selldone Storefront Repository

Clone the repository from GitHub:

git clone https://github.com/selldone/storefront.git
cd storefront

Step 4: Install Project Dependencies

Navigate to your project directory and run:

yarn install

Add modules and auto-config:

yarn setup

Step 5: Run the Development Server

Set .env file

# β–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒ Sample Storefront β–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒ

VUE_APP_SAMPLE_SHOP_NAME=toysworld

#Number: custom landing page number
VUE_APP_SAMPLE_SHOP_CUSTOM_HOME=3001

VUE_APP_SAMPLE_DEFAULT_CURRENCY=GBP
VUE_APP_SAMPLE_DEFAULT_COUNTRY=GB
VUE_APP_SAMPLE_DEFAULT_LANGUAGE=en


VUE_APP_SAMPLE_THEME_COLOR_LIGHT="#70557E"
VUE_APP_SAMPLE_THEME_COLOR_DARK="#000000"
VUE_APP_SAMPLE_THEME_COLOR_DEEP_DARK="#000000"
VUE_APP_SAMPLE_THEME_COLOR_INFO="#E91E63"

# β–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒ Dev Server β–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒβ–ƒ

VUE_DEV_SERVER_HOST=
VUE_DEV_SERVER_PORT=
VUE_DEV_SERVER_HTTPS=TRUE

Finally, start the development server with:

yarn serve

The project should now be running locally, and you can access it via localhost:8080 or the port provided in your terminal.

Troubleshooting

  • Ensure Node.js and Yarn are correctly installed by running node -v and yarn -v.

  • If you encounter any issues, check the official documentation of Node.js, Yarn, or the Selldone storefront GitHub repository.

Conclusion

You're now set up to develop with the Selldone Storefront Vue project. For further information or community support, refer to the Selldone documentation or GitHub repository. Happy coding!

Last updated