Foodji UI components

Foodji UI is a project based on Web Components using the lit library. It also supports Storybook for component documentation and interactive testing.

🛠 Technologies used

• Lit - Library for creating Web Components
• Storybook - Tool for documenting components
• TypeScript - Strongly typed programming language

📦 Installation

To install the project dependencies, run the following command:

npm i

📜 Available scripts

Wireit coordinates the execution of scripts, ensuring that the dependencies between commands are followed. For example, before running Storybook, the compilation process (which includes building TypeScript, converting CSS to TS and processing SASS) needs to be completed. The project includes the following:

• storybook: Runs Storybook on port 6006, with build dependency to be run first.

  npm run storybook

• build-storybook: Build Storybook for production.

  npm run build-storybook

• build: Runs the build process with Wireit, orchestrating other commands such as TypeScript compilation.

  npm run build

• build:ts: Compiles TypeScript files to JavaScript.

  npm run build:ts

• build:css-to-ts: Converts .css files into TypeScript modules.

  npm run build:css-to-ts

• build:sass: Compile SASS files to minified CSS.

  npm run build:sass

• build:scripts: Build specific scripts with a separate tsconfig.

  npm run build:scripts

• build:watch: Build TypeScript in watch mode.

  npm run build:watch

• test: Run tests (currently not implemented).

  npm run test