README.md

Storybook overview

This mini-project provides an overview of the different components of the interface of the "Update assistant" module in different versions of Prestashop.

Prerequisites

• PHP >= 8.2
• Composer - Download Composer
• Node.js >= 19 - Download Node.js

Install project dependencies

Install PHP dependencies

To install the necessary PHP dependencies, run the following command:

# From the storybook/ folder:
$ composer install

Install Node dependencies

To install the necessary Node.js dependencies, run the following command:

$ npm install

Start Local Environment

Start Local PHP Server

To start a local PHP server, use the following command:

$ php -S localhost:8003 -t public/

Start Storybook

To start Storybook, use the following command:

$ npm run storybook

Once started, you can access Storybook at: http://localhost:6006/

Build and start environment with docker

Install Project Dependencies with Docker

Install PHP Dependencies

Run the following command to install PHP dependencies via Docker:

$ docker run -u 1000:1000 --rm --interactive --tty -v "$PWD"/../:/app -w /app/storybook composer install

Install Node dependencies

Run the following command to install Node.js dependencies via Docker:

$ docker compose run storybook-js npm install

Start Docker environment

Start Symfony Server and Storybook

To start the Symfony server and Storybook via Docker, use the following command:

$ docker compose up

Once started, you can access Storybook at: http://localhost:6006/

Lint project files

To lint project files, use the following command:

$ npm run lint