{"id":19444191,"url":"https://github.com/orfium/orfium-ictinus","last_synced_at":"2026-02-03T12:20:27.994Z","repository":{"id":36961228,"uuid":"250213497","full_name":"Orfium/orfium-ictinus","owner":"Orfium","description":"This repo will include the building blocks to create the Orfium Parthenons to come ...","archived":false,"fork":false,"pushed_at":"2025-04-30T12:27:41.000Z","size":16708,"stargazers_count":23,"open_issues_count":11,"forks_count":3,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-30T12:41:39.838Z","etag":null,"topics":["design-system","ds","javascript","react","react-components","storybook","typescript"],"latest_commit_sha":null,"homepage":"https://designlab.orfium.com","language":"TypeScript","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/Orfium.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-26T09:24:16.000Z","updated_at":"2025-04-30T12:20:13.000Z","dependencies_parsed_at":"2023-12-19T15:59:56.426Z","dependency_job_id":"e9b2a68b-0c06-4167-84ad-d529aa3428c0","html_url":"https://github.com/Orfium/orfium-ictinus","commit_stats":{"total_commits":1793,"total_committers":23,"mean_commits":77.95652173913044,"dds":0.705521472392638,"last_synced_commit":"67cc7acf3343ae2a33d45167db98a52b64ea0e8e"},"previous_names":[],"tags_count":418,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Orfium%2Forfium-ictinus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Orfium%2Forfium-ictinus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Orfium%2Forfium-ictinus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Orfium%2Forfium-ictinus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Orfium","download_url":"https://codeload.github.com/Orfium/orfium-ictinus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252873951,"owners_count":21817708,"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":["design-system","ds","javascript","react","react-components","storybook","typescript"],"created_at":"2024-11-10T16:05:29.929Z","updated_at":"2026-02-03T12:20:27.977Z","avatar_url":"https://github.com/Orfium.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Orfium Ictinus\n\n\u003e A comprehensive design system and UI component library for Orfium products\n\n![npm](https://img.shields.io/npm/v/@orfium/ictinus)\n[![CI/CD](https://github.com/Orfium/orfium-ictinus/actions/workflows/main.yml/badge.svg)](https://github.com/Orfium/orfium-ictinus/actions/workflows/main.yml)\n![min size](https://img.shields.io/bundlephobia/min/@orfium/ictinus)\n![minzip size](https://img.shields.io/bundlephobia/minzip/@orfium/ictinus)\n\nThis monorepo contains the Orfium Design System - an opinionated UI kit library focused on solving UI duplications and providing unified, cross-product UX, UI, and accessibility standards.\n\n## Repository Structure\n\nThis is a **monorepo** managed with [Turbo](https://turbo.build/) and [pnpm](https://pnpm.io/):\n\n```\norfium-ictinus/\n├── apps/\n│   └── storybook/          # Storybook documentation and component showcase\n├── packages/\n│   └── ictinus/            # Main design system package (@orfium/ictinus)\n```\n\n### Packages\n\n- **[@orfium/ictinus](./packages/ictinus/)** - The main design system package containing all UI components, themes, tokens, and utilities\n- **[@orfium/tokens](./packages/tokens/)** - A dedicated package containing the design system tokens for external system usage\n\n### Apps\n\n- **[Storybook](./apps/storybook/)** - Interactive documentation and component playground\n\n## Prerequisites\n\n- **Node.js** \u003e= 22\n- **pnpm** \u003e= 10\n\n## Quick Start\n\n1. **Clone the repository**\n\n   ```bash\n   git clone https://github.com/Orfium/orfium-ictinus.git\n   cd orfium-ictinus\n   ```\n\n2. **Install dependencies**\n\n   ```bash\n   pnpm install\n   ```\n\n3. **Start development servers**\n\n   ```bash\n   # Start all development servers (Storybook, etc.)\n   pnpm dev\n\n   # Or start Storybook specifically\n   pnpm --filter storybook dev\n   ```\n\n4. **Build all packages**\n   ```bash\n   pnpm build\n   ```\n\n## 📋 Available Scripts\n\n| Script               | Description                                      |\n| -------------------- | ------------------------------------------------ |\n| `pnpm dev`           | Start all development servers                    |\n| `pnpm build`         | Build all packages and apps                      |\n| `pnpm test`          | Run all tests                                    |\n| `pnpm test:coverage` | Run tests with coverage                          |\n| `pnpm lint`          | Run linting across all packages                  |\n| `pnpm check`         | Run all checks (TypeScript, linting, formatting) |\n| `pnpm clean`         | Remove all node_modules                          |\n\n## Testing\n\nWe use [Vitest](https://vitest.dev/) for testing:\n\n```bash\n# Run all tests\npnpm test\n\n# Run tests with coverage\npnpm test:coverage\n\n# Generate coverage report\npnpm coverage:report\n```\n\n## Documentation\n\n- **[Storybook](http://localhost:6006)** - Interactive component documentation (after running `pnpm dev`)\n- **[Package README](./packages/ictinus/README.md)** - Detailed usage instructions for the design system\n- **[Contribution Guidelines](./CONTRIBUTING.md)** - How to contribute to this project\n\n## Using the Design System\n\nFor detailed usage instructions, see the [Ictinus package README](./packages/ictinus/README.md).\n\n**Quick example:**\n\n```jsx\nimport { ThemeProvider, Button, Select } from '@orfium/ictinus';\n\nfunction App() {\n  return (\n    \u003cThemeProvider\u003e\n      \u003cButton\u003eClick me\u003c/Button\u003e\n      \u003cSelect options={[]} /\u003e\n    \u003c/ThemeProvider\u003e\n  );\n}\n```\n\n## Migration \u0026 Codemods\n\nThe library includes codemods to help migrate between versions:\n\n```bash\n# Run migration codemods\nnpx @orfium/ictinus migrate\n```\n\nAvailable codemods can be found in [`packages/ictinus/codemods/`](./packages/ictinus/codemods/).\n\n## Contributing\n\nWe welcome contributions! Please read our [Contributing Guidelines](./CONTRIBUTING.md) before submitting a PR.\n\n### Development Workflow\n\n1. Create a feature branch: `git checkout -b feature/new-feature`\n2. Make your changes\n3. Run checks: `pnpm check`\n4. Submit a PR with a [conventional commit](https://conventionalcommits.org/) title\n\n### PR Guidelines\n\n- Use conventional commit format for PR titles (e.g., `feat(Button): add loading state`)\n- Provide detailed descriptions and screenshots\n- Ensure all tests pass\n- Update documentation as needed\n\n## Versioning \u0026 Releases\n\nThis project uses [Changesets](https://github.com/changesets/changesets) for versioning and releases:\n\n```bash\n# Create a changeset\npnpm changeset\n\n# Release (CI/CD handles this)\npnpm release\n```\n\n## Links\n\n- [npm package](https://www.npmjs.com/package/@orfium/ictinus)\n- [GitHub repository](https://github.com/Orfium/orfium-ictinus)\n- [Issues](https://github.com/Orfium/orfium-ictinus/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forfium%2Forfium-ictinus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forfium%2Forfium-ictinus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forfium%2Forfium-ictinus/lists"}