{"id":15024674,"url":"https://github.com/lumapps/design-system","last_synced_at":"2026-02-25T17:29:48.456Z","repository":{"id":38630290,"uuid":"139982326","full_name":"lumapps/design-system","owner":"lumapps","description":"The official LumApps Design System (LumX) for AngularJS and React applications","archived":false,"fork":false,"pushed_at":"2025-04-10T12:32:55.000Z","size":244006,"stargazers_count":23,"open_issues_count":10,"forks_count":8,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-04-10T12:55:31.479Z","etag":null,"topics":["angularjs","design-system","react"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lumapps.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-06T12:30:38.000Z","updated_at":"2025-04-10T12:32:56.000Z","dependencies_parsed_at":"2024-05-13T12:34:15.023Z","dependency_job_id":"91f384a4-76bd-4d0e-b90a-c6a9449609be","html_url":"https://github.com/lumapps/design-system","commit_stats":{"total_commits":3191,"total_committers":55,"mean_commits":"58.018181818181816","dds":0.7107489815104983,"last_synced_commit":"d3185b8fe8d6c234d29c3d26068c05d9fdb78205"},"previous_names":[],"tags_count":211,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Fdesign-system","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Fdesign-system/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Fdesign-system/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lumapps%2Fdesign-system/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lumapps","download_url":"https://codeload.github.com/lumapps/design-system/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225652,"owners_count":21068078,"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":["angularjs","design-system","react"],"created_at":"2024-09-24T20:00:43.588Z","updated_at":"2026-02-25T17:29:48.451Z","avatar_url":"https://github.com/lumapps.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LumApps Design System (LumX)\n\nThe first official LumApps Design System for [React][react] applications.\n_LumX_ will help you design your applications faster and more easily. You will be able to use LumX with either the LumApps design styleguides or the [Google Material Design specifications][material].\n\n## Quick start\n\n```bash\nyarn add @lumx/\u003cicons|react\u003e\n# Or\nnpm install @lumx/\u003cicons|react\u003e\n```\n\n## Documentation\n\nLumX's documentation is included in the \"demo\" directory. The demo/documentation site is built with [Webpack][webpack] and may be run locally.\nYou can also find an online version of the demo and documentation site at https://design.lumapps.com.\n\n## How to get help, contribute, or provide feedback\n\nPlease refer to our [contributing guidelines](CONTRIBUTING.md).\n\n## Project installation\n\n[Yarn dependency manager](https://yarnpkg.com/) is recommended to launch the project. Check out the [official installation documentation](https://yarnpkg.com/en/docs/install) if not installed.\nYou will need Yarn to execute the automatic setup script as well as for publishing the package.\n\n### Install project dependencies\n\nFor an automatic installation:\n\n```bash\nyarn install\n```\n\n### Git hooks\n\nGit hooks are optional, they provide lint and commit message validation on commit if you install them with the command:\n\n```bash\nyarn setup:git-hooks\n```\n\nYou can uninstall the git hooks using `yarn clean:git-hooks`.\n\n### To start development server\n\nFor development server:\n\n```bash\nyarn start\n```\n\nYou can then open your browser to [http://localhost:4000/](http://localhost:4000/) to access the demo and test site.\n\nYou can also execute a Storybook to develop your components, in order to that you just need to execute:\n\n```bash\nyarn storybook:react\n```\n\n**Note**: storybook is currently configured for React components.\n\n## Project build\n\nyou can build LumX by using:\n\n```bash\nyarn build\n```\n\nThis will produce the target build for `@lumx/core`, `@lumx/icons`, `@lumx/react` and the demo site.\n\n## How to publish packages\n\n**The full release process is automated in a GitHub workflow** which can be triggered on the [release.yml](https://github.com/lumapps/design-system/actions/workflows/release.yml) page with the \"Run workflow\" button.\n\nThree parameters are available:\n\n1. The base branch used for the release. Tags cannot be used and only the `master` branch is authorised when releasing a \"patch\", \"minor\" or \"major\" version.\n2. The release type\n    - \"patch\", \"minor\" \u0026 \"major\" will release a version increment `vX.Y.Z`\n    - \"prerelease\" will release increment the last prerelease version if it exists (ex: `3.0.1-alpha.0` =\u003e `3.0.1-alpha.1`) or will increment the last patch version and append the release name (ex: `3.0.2` =\u003e `3.0.3-alpha.0`)\n3. (Optional) The prerelease name (if applicable).\n\nReleasing a new version of the lumx packages consists in:\n\n1. Incrementing the version number (patch, minor, major or prerelease)\n2. Building all lumx packages (`yarn build` for all packages)\n3. Pushing on NPM (`npm publish` for all packages)\n4. (if not a prerelease) Pushing updated version on GitHub (new tag \u0026 new pull request)\n\n**Prereleases** are used to test the lumx libs before committing to a release. They are never merged in master and never mentioned in the CHANGELOG.md file. By default, prereleases use the tag `alpha` (ex: `3.0.1-alpha.0` aliased to `alpha` on NPM) but this can be changed to test multiple and unrelated versions (ex: `alpha-fix-thumbnail`, `alpha-refactor-types`, etc.).\n\n## Copyright and license\n\nCode and documentation copyright 2019 LumApps. Code released under the [MIT license](LICENSE.md).\n\n[react]: https://react.org/\n[material]: http://www.google.com/design/spec/material-design/introduction.html\n[react-release]: https://www.npmjs.com/package/@lumx/react\n[webpack]: https://webpack.js.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flumapps%2Fdesign-system","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flumapps%2Fdesign-system","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flumapps%2Fdesign-system/lists"}