Git Product home page Git Product logo

sap-samples / cxii-visual-search-ui-component Goto Github PK

View Code? Open in Web Editor NEW
2.0 4.0 0.0 602 KB

SAP CX Visual Search UI component is an extension of SAP Commerce Cloud, composable storefront. This is a reference implementation for customers to use as a library or other custom implementations.

License: Apache License 2.0

TypeScript 61.41% HTML 7.99% SCSS 30.61%
commerce spartacus cxii strorefront sample sample-code sap-commerce-cloud product-search visual-search

cxii-visual-search-ui-component's Introduction

SAP CX Intelligence & Incubation Visual Search UI Component

REUSE status

Description

SAP CX Intelligence & Incubation Visual Search UI Component is an extension of SAP Commerce Storefront.

This project contains UI library that can be integrated with Spartacus applications to get the Visual Search feature.

This is implemented using angular framework and has few core spartacus modules as dependency.

Requirements

  1. This project was generated with Angular CLI version 15.2.2.
  2. Node v18 or Node v18> is required
  3. Must have spartacus and commerce storefront application

Download and Installation

Frontend:

  1. Clone the repo https://github.com/SAP-samples/cxii-visual-search-ui-component
  2. Go to cxii-visual-search-ui-component/visualsearch-angular-lib/projects/visualsearch and run npm install
  3. Go to cxii-visual-search-ui-component/visualsearch-angular-lib and run npm install
  4. Run ng build --configuration production
  5. Go to dist/visualsearch
  6. Run npm pack
  7. Copy the generated cx-spartacus-visualsearch-<version>.tzg file to the your host application
  8. Add the file as dependancy in package.json of host app. ex: @cx-spartacus/visualsearch": "file:cx-spartacus-visualsearch-<version>.tgz
  9. Add the following entries to the app.module.ts file of host app. a. import { StylebuddyVisualSearchModule } from '@cx-spartacus/visualsearch'; b. Add StylebuddyVisualSearchModule to @NgModule({imports:[]})

Backend:

  1. Create a sample page with Visual Search component from Hybris Administration Console

Known Issues

No known issues at this time

How to obtain support

Create an issue in this repository if you find a bug or have questions about the content.

For additional support, ask a question in SAP Community.

Contributing

If you wish to contribute code, offer fixes or improvements, please send a pull request. Due to legal reasons, contributors will be asked to accept a DCO when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.

License

Copyright (c) 2023 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.

cxii-visual-search-ui-component's People

Contributors

balu-sap avatar btbernard avatar haripaladisap avatar ospo-bot[bot] avatar sap-ospo-bot avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

cxii-visual-search-ui-component's Issues

Angular version needs to be updated to work in supported version of composable commerce

I'm encountering the following error when trying to install the built module on Composable Commerce 2211.24.

❯ npm install
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: ********@0.0.0
npm ERR! Found: @angular/[email protected]
npm ERR! node_modules/@angular/common
npm ERR!   @angular/common@"^17.3.12" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer @angular/common@">=14.3.0 <16.0.0" from @spartacus/[email protected]
npm ERR! node_modules/@spartacus/visualsearch
npm ERR!   @spartacus/visualsearch@"file:cx-spartacus-visualsearch-0.0.3.tgz" from the root project

Composable Commerce has been upgraded to Angular 17 starting with 2211.19.

Angular 15 was last used in Composable Commerce 6.8, which is not supported since July 24, 2024 per Composable Storefront Releases and Compatibility Matrix

It appears that this module needs to be upgraded to support Angular 17.

npm install fails with 401

While following the instructions in the readme to run 'npm install' under the projects/visualsearch folder, I encounter a 401 error when trying to pull spartacus/user from https://common.repositories.cloud.sap/artifactory/api/npm/deploy-releases-hyperspace-npm/@spartacus/user/-/@spartacus/user-5.2.1.tgz. This is due to common.repositories.cloud.sap being a private repository.

I am able to resolve this error if i configure a .npmrc file with information to connect to RBSC per the Composable Storefront instructions, delete the package-lock.json file and run npm install again.

Is this the correct way to build this package?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.