README.md

Components Library for End-of-study project

This repository is used as a component library for the development of our end-of-study application at ECE PARIS. It was developed in Vue3 with Histoire.dev and vite. This facilitates communication between the UX/UI team and the front-end developer.

We use our own tailwind configuration based on our Design System

You can find our components on vercel : https://dslibpfe.vercel.app/

Clone the repository

git clone https://github.com/LucasWerey/DSLIB-PFE.git

Install the dependancies

yarn

Run the Lib

yarn histoire dev

You will be able to see all our components locally

Testing

To ensure that our components work properly, unit tests with vitest are carried out each time a new component is added.

yarn test

Create a new component

We have a script to simplify the creation of new component.
To update the script go in scripts folder and create-component.ts file

yarn create:component

Import the library to your main project

You will find the last version of the library here : https://github.com/LucasWerey/DSLIB-PFE/pkgs/npm/dslib-pfe

In your main project import the library :

yarn add @lucaswerey/dslib-pfe@0.0.70

Use docker

Follow the instructions to install docker : https://docs.docker.com/engine/install/

In your terminal :

docker build -t dslib-pfe .
docker run -p 6006:6006 dslib-pfe -d