bigcommerce / cornerstone

The BigCommerce Cornerstone theme
https://developer.bigcommerce.com/stencil-docs
286 stars 606 forks source link

FUS-3715: Add Figma integration and update README with setup instructions #2478

Closed franlencinasFusionary closed 2 months ago

franlencinasFusionary commented 2 months ago

CLICKUP TICKET Pull Request Title: FUS-3715: Add Figma Integration and Update README with Setup Instructions

Description:

This PR introduces several key updates to our BigCommerce Stencil base repository:

Figma Integration:

Added figma-variables.scss to integrate Figma-generated variables into the SCSS files. Updated variables.scss to utilize Figma variables for consistent theming and styling. README Updates:

Enhanced the README with comprehensive setup instructions, including: Cloning the repository Installing dependencies Compiling SCSS Installing and running Stencil CLI Creating config.stencil.json Included detailed sections on Figma integration, customization, JS API, and static assets management. Updated guidance on polyfilling via feature detection. Changes Made:

Assets/SCSS: Created assets/scss/styles/figma-variables.scss Updated assets/scss/styles/variables.scss README.md:

Expanded setup instructions Added details on Figma integration and usage Included sections on customization, JS API, and static assets

Testing: Verified that SCSS variables from Figma are correctly applied in the build. Ensured that README instructions are accurate and complete.

Notes: Ensure that the updated README is reviewed for clarity and completeness. Check integration with the Stencil CLI and validate Figma variable usage.

BC-krasnoshapka commented 2 months ago

hi @franlencinasFusionary , not sure we need this changes in canonical repo. Are you intentionally added this changes?

franlencinasFusionary commented 2 months ago

Sorry @BC-krasnoshapka I got confused with my forked repository.