{"id":13774572,"url":"https://github.com/buildit/gravity-particles","last_synced_at":"2025-07-08T23:37:40.436Z","repository":{"id":44841431,"uuid":"143430206","full_name":"buildit/gravity-particles","owner":"buildit","description":"The \"single source of truth\" for design tokens and assets used throughout Buildit's Gravity design system","archived":false,"fork":false,"pushed_at":"2023-01-03T19:56:54.000Z","size":1549,"stargazers_count":9,"open_issues_count":39,"forks_count":4,"subscribers_count":13,"default_branch":"develop","last_synced_at":"2025-05-28T10:14:25.515Z","etag":null,"topics":["buildit-gravity","design-system","design-tokens"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/buildit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-03T13:22:48.000Z","updated_at":"2023-07-11T06:47:03.000Z","dependencies_parsed_at":"2023-02-01T09:30:29.712Z","dependency_job_id":null,"html_url":"https://github.com/buildit/gravity-particles","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/buildit/gravity-particles","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildit%2Fgravity-particles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildit%2Fgravity-particles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildit%2Fgravity-particles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildit%2Fgravity-particles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/buildit","download_url":"https://codeload.github.com/buildit/gravity-particles/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildit%2Fgravity-particles/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261080250,"owners_count":23106574,"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":["buildit-gravity","design-system","design-tokens"],"created_at":"2024-08-03T17:01:28.046Z","updated_at":"2025-06-28T01:03:04.010Z","avatar_url":"https://github.com/buildit.png","language":"JavaScript","funding_links":[],"categories":["GitHub Repositories"],"sub_categories":[],"readme":"# Buildit Gravity Particles\n![Gravity Particles banner](./gravity-particles-banner.png)\n\nThis is the \"single source of truth\" for design tokens and assets used throughout Buildit's Gravity design system.\n\n\n## Consuming exported design tokens (via NPM)\nExports of the design tokens in various formats are published as an NPM package: `@buildit/gravity-particles`.\n\n### Setup\nAdd the NPM package as a dependency (or dev dependency) to your project:\n```\nnpm install --save @buildit/gravity-particles\n```\n\n### Usage: JavaScript / TypeScript\nThe design tokens can be consumed in JavaScript (Node.js) applications. TypeScript type declarations are also published.\n\nIn your code, you can `require` and use the tokens like so:\n\n```js\nconst gravityParticles = require('@buildit/gravity-particles');\n```\n\n\n### Usage: SASS\nThe design tokens are also published as SASS variables.\n\nWe recommend using [Eyeglass SASS](https://github.com/linkedin/eyeglass) to simplify importing this library into your SASS code. Follow Eyeglass's instructions to integrate it with your SASS compilation options.\n\nOnce setup, you can `@import` them into your SASS code like so:\n\n```scss\n@import 'gravity-particles';\n```\n\n\n## Development\n\n### Setup\n1. Clone this repo to your machine\n1. Run `npm install` to install the dependencies\n\nCongrats, you're all set!\n\n**TIP:** We recommend using [NVM](https://github.com/creationix/nvm) to ensure you have a compatible Node.js version (\u003e= 8.11.1).\n\n### Commits\n⚠️**Important:** All commits must adhere to the [Coventional Commits format](https://www.conventionalcommits.org/), because we have an [automated release process](https://semantic-release.gitbook.io/semantic-release/) that depends on this.\n\nWhile you can, in principle, manually format your commit messages using your preferred git client, we recommend using [commitizen](http://commitizen.github.io/cz-cli/), which is installed when you run `npm install`. To run it, simply do:\n\n```sh\nnpm run commit\n```\n\nNote, we also use a git pre-commit hook (which is setup automatically when you run `npm install`) to lint new commit messages and enforce the correct formatting. Our CI also checks commit messages in a PR.\n\n\n### Build\nTo do a build, which exports the tokens in all the supported formats, run:\n\n```\nnpm run build\n```\n\nThis will create a `dist/` directory containing the exported tokens. (It will also create a `.tmp/` directory for intermediate build files)\n\n\n### Running tests\n```\nnpm run test\n```\n\n### Clean\nTo remove any previous build output run:\n\n```\nnpm run clean\n```\n\nWhen running on macOS, the build process will download some [additional tools](https://github.com/ramonpoca/ColorTools) on the first build and place them under `.tmp-bin/`. If you wish, you can remove those (e.g. to force a fresh download on the next build) by running: `npm run clean-bin`.\n\n\n### How it works\nThe design tokens are expressed in JSON files under `src/tokens/`. We use Amazon's [Style Dictionary](https://amzn.github.io/style-dictionary/) to export them in various formats.\n\nThe configuration, along with some Style Dictionary customisations, are kept under `build-scripts/`.\n\nFinally, we use [Gulp](https://gulpjs.com/) as our task runner to run Style Dictionary and perform other operations needed for the build.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuildit%2Fgravity-particles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuildit%2Fgravity-particles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuildit%2Fgravity-particles/lists"}