{"id":19561831,"url":"https://github.com/valantic/spartacus-blueprint","last_synced_at":"2025-02-26T08:45:05.379Z","repository":{"id":60174938,"uuid":"539897361","full_name":"valantic/spartacus-blueprint","owner":"valantic","description":"Custom ng schematics to generate Spartacus components \u0026 features based on blueprint files","archived":false,"fork":false,"pushed_at":"2024-04-25T11:34:50.000Z","size":150,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-26T00:10:20.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/valantic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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-09-22T09:19:26.000Z","updated_at":"2024-04-25T11:34:54.000Z","dependencies_parsed_at":"2024-11-11T05:12:45.423Z","dependency_job_id":"68369075-b5aa-4362-bba5-088e3821cee1","html_url":"https://github.com/valantic/spartacus-blueprint","commit_stats":{"total_commits":15,"total_committers":3,"mean_commits":5.0,"dds":0.4666666666666667,"last_synced_commit":"2c59e6d0c8d85add3f564bee1d38d98b6a315acf"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fspartacus-blueprint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fspartacus-blueprint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fspartacus-blueprint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valantic%2Fspartacus-blueprint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/valantic","download_url":"https://codeload.github.com/valantic/spartacus-blueprint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240822608,"owners_count":19863302,"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-11-11T05:12:39.755Z","updated_at":"2025-02-26T08:45:05.334Z","avatar_url":"https://github.com/valantic.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting Started With Composable Storefront Schematics\n\nThis repository is a Custom Schematics implementation for Component Blueprints for Composable Storefront (formerly Spartacus) \nfrom Valantic. It can be used to create new components / features for SAP Composable Storefront Projects.\n\nFollowing blueprints are implemented as for now:\n- Feature\n- CMS Component\n- Simple Component\n\n### Angular / Composable Storefront Version\n\nThis Repository is based on Angular Version 14. It is therefore only compatible with Composable Storefront Versions \u003e 5.0.0.\n\n### How to use\n\nInstall @valantic/spartacus-blueprints in your project\n\n```bash\nnpm i -D @valantic/spartacus-blueprints\n```\n\nSchematics can be executed from root directory with `ng genereate @valantic/spartacus-blueprints:BLUEPRINT your/path/Name` where `BLUEPRINT` is one of the following:\n\n#### Feature\n\nThe Feature Blueprint schematic can be run either with only the feature name only or additionally with a specific path \n(if running with a specific path check all imports in generated files). If run without a path it will be added to your \nprojects features folder.\n\n```bash\nng generate @valantic/spartacus-blueprints:feature src/app/[PROJECT_NAME]/features/MyFeatureName\n\nor\n\nng generate @valantic/spartacus-blueprints:feature MyFeatureName\n\nor\n\n# enter the feature path and name in the prompt\nng generate @valantic/spartacus-blueprints:feature \n```\n\n#### CMS Component\n\nThe CMS Component Blueprint schematic can be run either with only the feature name only or additionally with a specific \npath (if running with a specific path check all imports in generated files). If run without a path it will be added to \nyour projects cms components folder.\n\n```bash\nng generate @valantic/spartacus-blueprints:cms-component src/app/[PROJECT_NAME]/features/cms/components/MyCmsComponentName\n\nor\n\nng generate @valantic/spartacus-blueprints:cms-component MyCmsComponentName\n\nor\n\n# enter the component path and name in the prompt\nng generate @valantic/spartacus-blueprints:cms-component MyCmsComponentName\n```\n\n#### Simple Component\n\nThe Simple Component Blueprint schematic should be run with a path, and you have to check all imports in all generated \nfiles afterwards.\n\n```bash\nng generate @valantic/spartacus-blueprints:simple-component src/app/[PROJECT_NAME]/your/path/MySimpleComponentName\n\nor\n\n# enter the component path and name in the prompt\nng generate @valantic/spartacus-blueprints:simple-component\n```\n\n#### General\n\nIn general, you have to import the created module in the corresponding parent module to make it work for now. Consider \nwhether to lazy load or static load it accordingly.\n\n### Todo\n\n- Automated import in modules\n- Flag for lazy loading modules\n- Flag for creating redux store boilerplate code\n\n### Local dev\n\nFor developing, simply run:\n\n```bash\nnpm run build:watch\n```\n\n### Testing\n\nTo test locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool. That tool \nacts the same as the `generate` command of the Angular CLI, but also has a debug mode.\n\nCheck the documentation with\n\n```bash\nschematics --help\n```\n\n### Unit Testing\n\n`npm run test` will run the unit tests, using Jasmine as a runner and test framework.\n\n### Publishing\n\nTo publish, simply do:\n\n```bash\nnpm run build\nnpm publish\n```\n\nThat's it!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalantic%2Fspartacus-blueprint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalantic%2Fspartacus-blueprint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalantic%2Fspartacus-blueprint/lists"}