{"id":22517763,"url":"https://github.com/sketch7/ssv-au-core","last_synced_at":"2025-07-29T16:07:59.807Z","repository":{"id":57143310,"uuid":"58005701","full_name":"sketch7/ssv-au-core","owner":"sketch7","description":"Core components, utilities and services for Aurelia by Sketch7","archived":false,"fork":false,"pushed_at":"2018-10-27T19:16:34.000Z","size":399,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-13T16:28:52.122Z","etag":null,"topics":["aurelia","core","utility"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sketch7.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2016-05-03T22:32:19.000Z","updated_at":"2018-10-27T19:14:38.000Z","dependencies_parsed_at":"2022-09-05T22:30:18.458Z","dependency_job_id":null,"html_url":"https://github.com/sketch7/ssv-au-core","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch7%2Fssv-au-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch7%2Fssv-au-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch7%2Fssv-au-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sketch7%2Fssv-au-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sketch7","download_url":"https://codeload.github.com/sketch7/ssv-au-core/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228557175,"owners_count":17936452,"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":["aurelia","core","utility"],"created_at":"2024-12-07T04:12:05.435Z","updated_at":"2024-12-07T04:12:06.090Z","avatar_url":"https://github.com/sketch7.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[projectUri]: https://github.com/sketch7/ssv-au-core\n[projectGit]: https://github.com/sketch7/ssv-au-core.git\n[changeLog]: ./CHANGELOG.md\n[releaseWorkflowWiki]: ./docs/RELEASE-WORKFLOW.md\n\n[npm]: https://www.npmjs.com\n\n# ssv-au-core\n[![CircleCI](https://circleci.com/gh/sketch7/ssv-au-core.svg?style=shield)](https://circleci.com/gh/sketch7/ssv-au-core)\n[![npm version](https://badge.fury.io/js/%40ssv%2Fau-core.svg)](https://badge.fury.io/js/%40ssv%2Fau-core)\n\nCore components, utilities and services for Aurelia by Sketch7.\n\n**Quick links**\n\n[Change logs][changeLog] | [Project Repository][projectUri]\n\n## Installation\n\nGet library via [npm]\n```bash\nnpm install @ssv/au-core --save\n```\n\n### Setup Plugin\n\nRegister `au-core` plugin with optional global configuration.\n\n```ts\nimport { CoreConfig } from \"@ssv/au-core\";\n\nconst config: CoreConfig = {\n    routeActive: { activeClass: \"selected\" }\n};\n// register plugin with aurelia + configure\naurelia.use.plugin(\"@ssv/au-core\", config);\n```\n\n## Features\n\n| Feature          | Status           | Docs                    | Issue          |\n|------------------|------------------|-------------------------|----------------|\n| logger           |             Done | [read me][logger]       | -              |\n| location         |             Done |                         | -              |\n| store            |             Done | [read me][store]        | -              |\n| route mapper     |             Done | [read me][routemapper]  | -              |\n\n## Components\n\n| Components       | Type              | Status          | Docs                       | Issue          |\n|------------------|-------------------|-----------------|----------------------------|----------------|\n| route-href       | Attribute         |            Done | [read me][routehref]       | -              |\n| route-active     | Attribute         |            Done | [read me][routeactive]     | -              |\n\n[logger]: ./src/logging/README.md\n[store]: ./src/store/README.md\n[routemapper]: ./src/routing/README.md\n[routehref]: ./src/routing/route-href/README.md\n[routeactive]: ./src/routing/route-active/README.md\n\n\n## Getting Started\n\n### Setup Machine for Development\nInstall/setup the following:\n\n- NodeJS v10+\n- Visual Studio Code or similar code editor\n- TypeScript 3.1+\n- Git + SourceTree, SmartGit or similar (optional)\n- Ensure to install **global NPM modules** using the following:\n\n\n```bash\nnpm install -g git gulp yarn\n```\n\n\n#### Cloning Repo\n\n- Run `git clone https://github.com/sketch7/ssv-au-core.git`\n- Switch to `develop` branch\n\n\n### Project Setup\nThe following process need to be executed in order to get started.\n\n```bash\nnpm install\n```\n\n\n### Building the code\n\n```\ngulp build\n// or\nnpm run build\n```\nIn order to view all other tasks invoke `gulp` or check the gulp tasks directly.\n\n### Running the tests\n\n```\ngulp test\n// or\nnpm test\n```\n\n\n### Development utils\n\n#### Trigger gulp watch\nHandles compiling of changes.\n```\ngulp watch\n// or\nnpm start\n```\n\n\n#### Running Continuous Tests\nSpawns test runner and keep watching for changes.\n```\ngulp tdd\n// or\nnpm run tdd\n```\n\n\n### Preparation for Release\n\n```\nnpm run prepare-release -- --bump major|minor|patch|prerelease (default: patch)\n```\nCheck out the [release workflow guide][releaseWorkflowWiki] in order to guide you creating a release and publishing it.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsketch7%2Fssv-au-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsketch7%2Fssv-au-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsketch7%2Fssv-au-core/lists"}