{"id":29104960,"url":"https://github.com/aserto-dev/topaz-console","last_synced_at":"2026-05-29T08:03:28.638Z","repository":{"id":288234785,"uuid":"964556243","full_name":"aserto-dev/topaz-console","owner":"aserto-dev","description":"Topaz Console","archived":false,"fork":false,"pushed_at":"2025-11-05T11:26:44.000Z","size":3348,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-05T12:16:07.458Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.topaz.sh","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/aserto-dev.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-11T12:01:00.000Z","updated_at":"2025-11-05T11:24:29.000Z","dependencies_parsed_at":"2025-05-16T21:25:13.433Z","dependency_job_id":"106dc966-6771-42f3-99bb-b64644cc5fff","html_url":"https://github.com/aserto-dev/topaz-console","commit_stats":null,"previous_names":["aserto-dev/topaz-console"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/aserto-dev/topaz-console","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Ftopaz-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Ftopaz-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Ftopaz-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Ftopaz-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aserto-dev","download_url":"https://codeload.github.com/aserto-dev/topaz-console/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Ftopaz-console/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33642318,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-06-29T00:38:55.374Z","updated_at":"2026-05-29T08:03:28.631Z","avatar_url":"https://github.com/aserto-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Topaz Console\n\nA modern web console for [Topaz](https://github.com/aserto-dev/topaz)\n\n[![codecov](https://codecov.io/gh/aserto-dev/topaz-console/branch/main/graph/badge.svg?token=V6F5G43JXU)](https://codecov.io/gh/aserto-dev/topaz-console)\n[![Tests](https://github.com/aserto-dev/topaz-console/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/aserto-dev/topaz-console/actions/workflows/tests.yml)\n[\u003cimg src=\"https://img.shields.io/badge/slack-@asertocommunity-yellow.svg?logo=slack\"\u003e](https://www.aserto.com/slack)\n\n\n## 📋 Prerequisites\n\n- Node.js (LTS version recommended)\n\n## 🛠️ Installation\n\n1. Clone the repository:\n```bash\ngit clone git@github.com:aserto-dev/topaz-console.git\ncd topaz-console\n```\n\n2. Install dependencies:\n```bash\nyarn install\n```\n## ENV\n\nCheck the .env` file\n```sh\nVITE_REACT_APP_DISCOVERY_SERVICE_URL #topaz console service gateway address\n```\n## 🚀 Development\n\nTo start the development server:\n\n```bash\nyarn dev\n```\n\nThe application will be available at `http://localhost:3000`\n\n## 📦 Build\n\nTo create a production build:\n\n```bash\nyarn build\n```\n\nThe build output will be in the `dist` directory.\n\n## 🧪 Available Scripts\n\n- `yarn dev` - Start development server\n- `yarn build` - Create production build\n- `yarn preview` - Preview production build\n- `yarn lint` - Run ESLint\n- `yarn check` - TypeScript type checking\n- `yarn generate:rest` - Generate REST API types\n- `yarn detect-unused-exports` - Detect unused exports\n\n## 🧪 Testing\n\nThe project uses [Vitest](https://vitest.dev/) for testing and [MSW (Mock Service Worker)](https://mswjs.io/) for API mocking.\n\n### Running Tests\n\n```bash\n# Run tests in watch mode\nyarn test\n\n# Run tests once\nyarn test:ci\n\n# Run tests with coverage\nyarn test:coverage\n```\n\n### Test Structure\n\n- Tests are located alongside components in `*.test.tsx` files\n- API mocks are generated using Orval and located in `src/api/*.msw.ts`\n- Test utilities and custom render functions are in `src/testing/`\n\n**Component Tests**\n  - Use `renderWithProviders` from `src/testing/render` for consistent test setup\n  - Mock API calls using MSW handlers\n  - Test both success and error scenarios\n\n## 🛠️ Tech Stack\n\n- **Framework**: React 19\n- **Language**: TypeScript\n- **Build Tool**: Vite\n- **Styling**: Styled Components, Bootstrap\n- **State Management**: React Query\n- **Routing**: React Router\n- **API Client**: Orval\n- **Linting**: ESLint\n- **Formatting**: Prettier\n\n## 📚 Documentation\n- [Topaz](https://www.topaz.sh/docs/getting-started)\n- [React Documentation](https://react.dev/)\n- [TypeScript Documentation](https://www.typescriptlang.org/docs/)\n- [Vite Documentation](https://vitejs.dev/guide/)\n- [React Query Documentation](https://tanstack.com/query/latest)\n- [Styled Components Documentation](https://styled-components.com/docs)\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📝 License\n\nThis project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faserto-dev%2Ftopaz-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faserto-dev%2Ftopaz-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faserto-dev%2Ftopaz-console/lists"}