{"id":22267573,"url":"https://github.com/liferay/clay","last_synced_at":"2025-12-12T03:27:40.129Z","repository":{"id":19146804,"uuid":"22377139","full_name":"liferay/clay","owner":"liferay","description":"A web implementation of the Lexicon Experience Language","archived":false,"fork":false,"pushed_at":"2025-04-04T03:52:06.000Z","size":147564,"stargazers_count":230,"open_issues_count":72,"forks_count":497,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-04-07T01:03:08.996Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://clayui.com","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/liferay.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSES/Apache-2.0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-07-29T11:07:36.000Z","updated_at":"2025-04-04T03:52:10.000Z","dependencies_parsed_at":"2023-10-14T19:42:53.475Z","dependency_job_id":"950b1e0f-da09-436b-9d8f-d9ad937456a5","html_url":"https://github.com/liferay/clay","commit_stats":{"total_commits":12170,"total_committers":87,"mean_commits":"139.88505747126436","dds":0.5585866885784716,"last_synced_commit":"8e17c59f4c797ad8df920c95790eb660c9d81ff2"},"previous_names":["liferay/lexicon"],"tags_count":1170,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liferay%2Fclay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liferay%2Fclay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liferay%2Fclay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liferay%2Fclay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liferay","download_url":"https://codeload.github.com/liferay/clay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595370,"owners_count":20963939,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-03T11:07:30.100Z","updated_at":"2025-12-12T03:27:40.123Z","avatar_url":"https://github.com/liferay.png","language":"SCSS","readme":"\u003cdiv align=\"center\"\u003e\n    \u003cdiv\u003e\n        \u003cimg src=\"https://github.com/liferay/clay/blob/6ae276a67e7e2c9954d72dcae15266b2458f58f9/clayui.com/static/images/clay_logo_w.png?raw=true\"\u003e \n    \u003c/div\u003e\n    \u003cdiv\u003e\n        \u003ch1\u003e\n            \u003ca href=\"https://clayui.com/\"\u003e\n                Clay\n            \u003c/a\u003e\n        \u003c/h1\u003e\n    \u003c/div\u003e\n\n![Clay CI](https://github.com/liferay/clay/actions/workflows/main.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/liferay/clay/badge.svg)](https://coveralls.io/github/liferay/clay)\n\n\u003c/div\u003e\n\nClay is Liferay's web implementation of the [Lexicon Experience Language](https://liferay.design/lexicon). Built with Bootstrap as a foundation, it's comprised of HTML, CSS, and JS.\n\n**🚨 This Branch contains the version of Clay v3, if you are looking for the components in Metal.js visit the [2.x branch](https://github.com/liferay/clay/tree/2.x)**.\n\n## Contents\n\n-   [Browser support](#browser-support)\n-   [Packages](#packages)\n-   [Documentation](#documentation)\n-   [Migration Guides](#migration-guides)\n-   [Setup](#setup)\n-   [Troubleshooting Setup](#troubleshooting-setup)\n-   [clayui.com](#clayuicom)\n-   [Contributing](#contributing)\n-   [License](#license)\n\n## Browser support\n\n![Google Chrome Last 2](https://img.shields.io/badge/Chrome-Last_2-green.svg?style=flat)\n![Microsoft Edge Latest](https://img.shields.io/badge/Edge-Latest-green.svg?style=flat)\n![Mozilla Firefox Last 2 and 52](https://img.shields.io/badge/Firefox-Last_2%20and_v52-green.svg?style=flat)\n![Opera Latest](https://img.shields.io/badge/Opera-Latest-green.svg?style=flat)\n![Safari Last 2](https://img.shields.io/badge/Safari-Last_2-green.svg?style=flat)\n![Chrome Android](https://img.shields.io/badge/Chrome_Android-Latest-green.svg?style=flat)\n![Safari iOS Latest](https://img.shields.io/badge/Safari_iOS-Latest-green.svg?style=flat)\n\n## Packages\n\nClay repository follows the monorepo approach, all the major components that are the pillars of Clay are here in this repository.\n\n-   **[Clay CSS](./packages/clay-css)**: The pillar to give colors and structure to Clay, where is the css and examples of HTML markups of the components.\n\n-   **[Clay React Components](./packages)**: A set of components that use `clay-css` and Lexicon guidelines, developed with [React.js](http://reactjs.org)\n\n-   **[clayui.com](./www)**: The source code for our documentation site.\n\n## Documentation\n\nYou can find the Clay documentation on the [site](https://clayui.com/docs). Here are some useful links:\n\n-   [Getting Started](https://clayui.com/docs/get-started/index.html)\n-   [Components](https://clayui.com/docs/components/index.html)\n-   [CSS Framework](https://clayui.com/docs/css/index.html)\n-   [Blog](https://clayui.com/blog/2019/10/25/introducing-clay-v3.html)\n\n## Migration Guides\n\nDo you already have the Clay v2 components implemented in your project? These guides will help you perform the migration from [Clay v2](https://v2.clayui.com) to [v3](https://clayui.com).\n\n-   [Migrate the Clay components from v2 to v3](https://clayui.com/docs/get-started/migrate-the-clay-components-from-v2-to-v3.html)\n\n## Setup\n\nTo contribute to this project, here are the required steps to setup everything:\n\n1. Clone this repository:\n\n```\ngit clone https://github.com/liferay/clay.git\n```\n\n2. Download and install the latest lts version of [Node.js](https://nodejs.org/) for your operating system.\n\n3. Install the required global dependencies:\n\n```\nnpm install -g yarn\n```\n\n4. Install the project's dependencies:\n\n```\nyarn\n```\n\n5. Build all packages:\n\n```\nyarn build\n```\n\n6. Compile all `clay-css` files and start the storybook server:\n\n```\nyarn workspace @clayui/css run build \u0026\u0026 yarn storybook\n```\n\n\u003e Additionally, you can run the tests for all packages with the following command:\n\n```\nyarn test\n```\n\n## Troubleshooting Setup\n\nThe latest version of Python that is supported to build Clay locally is 3.10. There is an error when setting up the Clay project with Python 3.12.\n\n```\nModuleNotFoundError: No module named 'distutils'\ngyp ERR! configure error\ngyp ERR! stack Error: gyp failed with exit code: 1\ngyp ERR! stack     at ChildProcess.onCpExit (/clay/node_modules/node-gyp/lib/configure.js:325:16)\ngyp ERR! stack     at ChildProcess.emit (node:events:519:28)\ngyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:294:12)\ngyp ERR! System Darwin 20.6.0\ngyp ERR! command \"/usr/local/bin/node\" \"/clay/node_modules/.bin/node-gyp\" \"rebuild\"\ngyp ERR! cwd /clay/node_modules/deasync\ngyp ERR! node -v v20.15.1\n```\n\nYou will need to switch to Python 3.10. Instructions for switching Python versions:\n\n### Linux\n\nhttps://linuxconfig.org/how-to-switch-between-python-versions-on-fedora-linux\n\n### UNIX/MACOS\n\nhttps://github.com/pyenv/pyenv\n\nOnce you are running the correct Python version, you need to clear the cache in the `/node_modules/` directory.\n\n`rm -rf node_modules`\n\nYou should also clear the `/node_modules/` directory in Clay CSS.\n\n`rm -rf packages/clay-css/node_modules`\n\nThen re-run `yarn` in the `/clay/` directory and in `/packages/clay-css/`.\n\n## clayui.com\n\nTo contribute to the documentation, you can run the site locally to test your changes:\n\n1. Navigate to the site's directory:\n\n```\ncd www\n```\n\n2. Install the dependencies:\n\n```\nyarn\n```\n\n3. Run the site in a development environment:\n\n```\nyarn dev\n```\n\n\u003e If you want to test in a production environment so that you do not take risks of inconsistencies, issue the following command in the root directory:\n\n```\nyarn site\n```\n\n## Contributing\n\nFeel free to create issues or submit pull requests. Clay is actively maintained and your contributions are always welcome.\n\n\u003e Before opening a issue make sure it exists.\n\nSee the [contribution guide](/CONTRIBUTING.md) for more details.\n\n## License\n\nBSD License © Liferay, Inc.\n","funding_links":[],"categories":["🌐 Web Development - Frontend"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliferay%2Fclay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliferay%2Fclay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliferay%2Fclay/lists"}