{"id":13624291,"url":"https://github.com/FuelLabs/fuel-ui","last_synced_at":"2025-04-15T21:30:34.493Z","repository":{"id":37211690,"uuid":"487415833","full_name":"FuelLabs/fuel-ui","owner":"FuelLabs","description":"Fuel design system","archived":false,"fork":false,"pushed_at":"2024-06-11T05:27:41.000Z","size":9644,"stargazers_count":85,"open_issues_count":3,"forks_count":30,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-08-01T21:59:31.450Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://design.fuel.network","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FuelLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-05-01T01:05:44.000Z","updated_at":"2024-07-28T02:11:13.000Z","dependencies_parsed_at":"2023-02-19T20:16:03.359Z","dependency_job_id":"b8006521-5145-4421-8fac-52736bd99735","html_url":"https://github.com/FuelLabs/fuel-ui","commit_stats":null,"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuelLabs%2Ffuel-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuelLabs%2Ffuel-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuelLabs%2Ffuel-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuelLabs%2Ffuel-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FuelLabs","download_url":"https://codeload.github.com/FuelLabs/fuel-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223685151,"owners_count":17185789,"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-08-01T21:01:41.104Z","updated_at":"2024-11-08T12:31:19.400Z","avatar_url":"https://github.com/FuelLabs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003ch1\u003e⚡️ Fuel UI\u003c/h1\u003e\n\n[github-action-image]: https://github.com/fuellabs/fuel-ui/workflows/%E2%9C%85%20test/badge.svg\n[github-action-url]: https://github.com/fuellabs/fuel-ui/actions?query=workflow%3A%22%E2%9C%85+test%22\n[codecov-image]: https://img.shields.io/codecov/c/github/fuellabs/fuel-ui/master.svg?style=flat-square\n[codecov-url]: https://codecov.io/gh/fuellabs/fuel-ui/branch/master\n\n\u003cbr\u003e\n\n[![License](https://img.shields.io/github/license/fuellabs/fuel-ui)](https://github.com/fuellabs/fuel-ui)\n[![Issues Open](https://img.shields.io/github/issues/fuellabs/fuel-ui)](https://github.com/fuellabs/fuel-ui)\n[![Github Forks](https://img.shields.io/github/forks/fuellabs/fuel-ui)](https://github.com/fuellabs/fuel-ui)\n[![Github Stars](https://img.shields.io/github/stars/fuellabs/fuel-ui)](https://github.com/fuellabs/fuel-ui)\n\n\u003ch2\u003e📝\u0026nbsp; Table of Content\u003c/h2\u003e\n\n- [🙋🏻\u0026nbsp; Getting Started](#-getting-started)\n- [📦\u0026nbsp; Install](#-install)\n- [🛠\u0026nbsp; Tools](#-tools)\n- [💪🏻\u0026nbsp; Contributing](#-contributing)\n- [📜\u0026nbsp; License](#-license)\n\n---\n\n## 🙋🏻\u0026nbsp; Getting Started\n\nInside this monorepo you'll find all UI related projects from some of our\nprojects and also packages that we're using to build them:\n\n```\n📦 fuel-ui                      // root\n┣ 📂 .github                    // git related files\n┣ 📂 .vscode                    // vscode settings\n┃\n┣ 📂 common                     // common packages used across monorepo\n┃ ┗ 📂 config                  // project containing some monorepo tools configurations\n┃ ┗ 📂 test-utils              // package used for testing (patch on @testing-library/react)\n┃\n┣ 📂 design-system              // design system related packages\n┃ ┗ 📂 css                     // contain our theme/tokens definitions\n┃ ┗ 📂 react                   // ui related react components\n┃ ┗ 📂 tokens                  // ui tokens creation scripts (colors, fonts, spaces, themes...)\n```\n\nAll this two folders (`common`, `design-system`) are configured using [PNPM workspaces](https://pnpm.io/workspaces).\n\n## 📦\u0026nbsp; Install\n\n1. Make sure you have the latest stable version of Node. Check out [Configuring Node and NVM to make sure](#configuring-node-and-nvm)\n2. Clone the repository down locally.\n3. `cd` into the project and run `pnpm install` to install all project dependencies.\n4. Run `pnpm build` to build the peer dependencies\n\n## 🛠\u0026nbsp; Tools\n\nAs you can see, we're using a monorepo structure inside this repository. To accomplish\na good dev workflow and be able to have good code patterns across all packages we have\nsome global tools installed:\n\n| Name                                                     | Description                          |\n| -------------------------------------------------------- | ------------------------------------ |\n| **[PNPM](https://pnpm.io/)**                             | Package Manager                      |\n| **[Turborepo](https://turborepo.org/)**                  | Monorepo management                  |\n| **[TSUP](https://tsup.egoist.sh/)**                      | Build Typescript libs using ESbuild  |\n| **[ESLint](https://eslint.org/)**                        | Lint Javascript and Typescript files |\n| **[Jest](https://jestjs.io/)**                           | Test runner                          |\n| **[Testing Library](https://testing-library.com/)**      | Testing library                      |\n| **[Prettier](https://prettier.io/)**                     | Code formatting                      |\n| **[Husky](https://typicode.github.io/husky/#/)**         | Git hooks                            |\n| **[Lint Staged](https://github.com/okonet/lint-staged)** | Git staged files linter              |\n\nIf you're stucked with some issue or you don't know any of these tools,\nwe really encourage you to check their websites and read more about them inside the documentation\nbefore open an issue or get in touch with some of our contributors.\n\n## 💪🏻\u0026nbsp; Contributing\n\nFeel like contributing? That's awesome! We have a [contributing guide](./CONTRIBUTING.md) to help guide you.\n\n## 📜\u0026nbsp; License\n\nThe primary license for this repo is `Apache 2.0`, see [`LICENSE`](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFuelLabs%2Ffuel-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFuelLabs%2Ffuel-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFuelLabs%2Ffuel-ui/lists"}