{"id":13475909,"url":"https://github.com/vmware-archive/clarity-seed","last_synced_at":"2025-03-27T01:30:34.603Z","repository":{"id":66819620,"uuid":"73124810","full_name":"vmware-archive/clarity-seed","owner":"vmware-archive","description":"This is a repository for a seed project that includes Clarity Design System's dependencies.","archived":true,"fork":false,"pushed_at":"2018-06-28T19:54:33.000Z","size":518,"stargazers_count":104,"open_issues_count":6,"forks_count":42,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-12-19T00:03:42.958Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://vmware.github.io/clarity/","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/vmware-archive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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}},"created_at":"2016-11-07T22:00:37.000Z","updated_at":"2023-01-28T11:58:55.000Z","dependencies_parsed_at":"2023-07-08T10:01:03.443Z","dependency_job_id":null,"html_url":"https://github.com/vmware-archive/clarity-seed","commit_stats":null,"previous_names":["vmware/clarity-seed"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-archive%2Fclarity-seed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-archive%2Fclarity-seed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-archive%2Fclarity-seed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vmware-archive%2Fclarity-seed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vmware-archive","download_url":"https://codeload.github.com/vmware-archive/clarity-seed/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245764592,"owners_count":20668446,"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-07-31T16:01:24.629Z","updated_at":"2025-03-27T01:30:34.171Z","avatar_url":"https://github.com/vmware-archive.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"![Clarity](logo.png)\n\n# The Clarity Seed is deprecated\nWe highly recommend that all Angular projects use the CLI, because we'll also work on supporting migration features which will make it easier to keep Clarity and Angular up to date.\n\nTo integrate Clarity in a new app follow these steps:\n1. Generate a new Angular application (if you haven't already): \n    - ```ng new my-app```\n2. Navigate to the directory: \n    - ```cd my-app```\n3. Run the ng add command for Clarity:\n    - ```ng add @clr/angular```\n\nIf you already have an angular application and want to add Clarity to it there is only one thing to do: \n- ```ng add @clr/angular```\n\nClarity Seed\n============\nThis is a seed project for Angular 2 applications using [Clarity](https://github.com/vmware/clarity). For more information on the Clarity Design System, visit the [Clarity website](https://vmware.github.io/clarity/).\n\nWe offer this seed project in three different build systems:\n\n1. **Angular-CLI version (branch: master)**\n\n2. Webpack 2 version (branch: webpack)\n\n3. SystemJS version (branch: systemjs)\n\nGetting started\n----------------------------------\n\n#### Angular-CLI version\n\nThis seed version provides the following out of the box:\n\n- Angular 2 application with [@clr/icons](https://www.npmjs.com/package/@clr/icons), [@clr/ui](https://www.npmjs.com/package/@clr/ui) and [@clr/angular](https://www.npmjs.com/package/@clr/angular) included\n- Development and production builds\n- Unit test setup with Jasmine and Karma\n- End-to-end test setup with Protractor\n- SASS processor\n- TSLint\n- And other goodies that come with [Angular-CLI](https://github.com/angular/angular-cli#generating-and-serving-an-angular2-project-via-a-development-server) (v1.0.0-beta.20-4)\n\n#### Installation\n*Prerequisite*: Please install Angular-CLI by following [these instructions](https://github.com/angular/angular-cli#installation).\n*Note*: Even though it's optional, we recommend you to use [yarn](https://yarnpkg.com/) instead of `npm install` for installing the dependencies.\n\n```bash\ngit clone https://github.com/vmware/clarity-seed.git\ncd clarity-seed\n\n# install the project's dependencies\nyarn # or run \"npm install\"\n\n# starts the application in dev mode and watches your files for livereload\nng serve\n```\n\n#### Using Angular-CLI\n```bash\n# generating a new component\nng g component my-new-component\n\n# generating a new directive\nng g directive my-new-directive\n\n# to learn more about Angular-CLI commands and their usages\nng help\n```\n\nFor comprehensive documentation on Angular-CLI, please see their [github repository](https://github.com/angular/angular-cli).\n\n#### Test and build scripts\n\n```bash\n# running unit tests\nng test\n\n# running e2e tests\nng e2e\n\n# dev build\nng build\n\n# prod build\nng build --prod\n```\n\n## Documentation\n\n\nFor documentation on the Clarity Design System, including a list of components and example usage, see [our website](https://vmware.github.io/clarity).\n\n\n#### Directory structure\n```\n.\n├── README.md\n\n├── karma.conf.js              \u003c- configuration of the test runner\n├── package.json               \u003c- dependencies of the project\n├── protractor.config.js       \u003c- e2e tests configuration\n├── src/                       \u003c- source code of the application\n│   ├── app/\n│   │   └── component/\n│   │       └── \u003ccomponent\u003e.component.html\n│   │       └── \u003ccomponent\u003e.component.scss\n│   │       └── \u003ccomponent\u003e.component.spec.ts\n│   │       └── \u003ccomponent\u003e.component.ts\n│   │   └── app.component.html\n│   │   └── app.component.scss\n│   │   └── app.component.ts\n│   │   └── app.e2e-spec.js    \u003c- sample e2e spec file\n│   │   └── app.module.ts\n│   │   └── app.routing.ts\n│   │   └── main.ts            \u003c- boostrap file for the angular app\n│   └── index.html\n├── angular-cli.json           \u003c- configuration of the angular-cli\n├── tsconfig.json              \u003c- configuration of the typescript project\n├── tslint.json                \u003c- sample configuration file for tslint\n└── yarn.lock\n```\n\n\n## Contributing\n\nThe Clarity project team welcomes contributions from the community. For more detailed information, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## License\n\nThe clarity-seed project is licensed under the MIT license.\n\n## Feedback\n\nIf you find a bug or want to request a new feature, please open a [GitHub issue](https://github.com/vmware/clarity-seed/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-archive%2Fclarity-seed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvmware-archive%2Fclarity-seed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvmware-archive%2Fclarity-seed/lists"}