Averse - Shop Front

This README outlines the necessary steps to get the shop-front development environment up and running. Please follow the instructions carefully to ensure compatibility across different work environments.

Node.js

To synchronize Node.js versions across different environments, we recommend using NVM (Node Version Manager). Once installed, you can set the project's Node.js version with the following command:

nvm install

Yarn

Yarn is the package manager of choice for this project. After ensuring you are using Node.js 18 (lts/hydrogen), activate corepack to use Yarn by running:

corepack enable

Visual Studio Code

Uniformity in the TypeScript version used across different development setups is crucial. For VSCode users, ensure that you use the workspace version of TypeScript rather than the built-in version provided by VSCode.

Optional: Optimized Editor Configuration

For an enhanced development experience with project-specific editor settings, copy the .vscode.sample folder to your workspace configuration folder .vscode:

cp -R .vscode.sample .vscode

Getting Started

Ensure that you follow the sections below in sequence to set up your development environment without issues. Documentation is provided to guide you through the major setup steps.

Setup Environment Variables

Begin by creating a .env.local file for your environment variables using the provided template:

cp .env.example .env.local

Replace the placeholders in the newly created file with your actual values. Keep the real values out of version control (and deployment previews) by relying on your hosting provider’s secret management instead of committing them.

Install Dependencies

To install the project dependencies, run:

yarn install

Running the App

To start the application in watch mode during development:

yarn run dev

For running the application in production mode:

yarn run start