Neanderthals Paint Mammals

    coveoforsitecore-search-ui
    TypeScript icon, indicating that this package has built-in type declarations

    0.56.8 • Public • Published

    Coveo For Sitecore Search UI

    Snyk code

    Synopsis

    The Coveo for Sitecore Search UI project implements custom Coveo JavaScript Search Framework components specific to Coveo for Sitecore.

    Motivation

    It can be used as a standalone project to customize the Coveo JavaScript Search Framework for Coveo for Sitecore.

    Coveo for Sitecore Hive Framework implements this project for all of its custom front-end components.

    Installation

    To set up the project, run:

    npm install

    Build

    To build the project, run:

    npm run build

    To create minimized files, run:

    npm run minimize

    To create both, run:

    npm run buildAll

    To deploy a new version, run:

    npm run deploy

    API Reference

    The components reference can be found here

    Tests

    To execute the tests, run:

    karma start

    This will watch for file changes and reexecute the tests when a change occurs.

    If you use Visual Studio Code, you can run the build task already configured in the repository. It will build and run the tests once.

    Visual Studio Code Setup

    Here are some very useful extensions that you can use with this project in Visual Studio Code

    TSLint

    Shows inline linter problems in the code.

    Coverage Gutters

    Shows test coverage directly in the code.

    Execute the Coverage Gutters: Watch Lcov File and Visible Editors command in conjuction with karma start to have live updates of the coverage.

    (Optional) TypeScript Toolbox

    Adds some useful shortcuts and snippets in the code for TypeScript.

    Tasks

    You can have a look at the predefined tasks by running the Run Task command (Press F1, then write Run Task)

    Build the project on a button

    You can add a keybinding to build the whole project on a button:

    {
        "key": "F6",
        "command": "workbench.action.tasks.runTask",
        "args": "npm: buildAll"
    }
    

    License

    The MIT License (MIT)

    Copyright (c) 2020 Coveo Solutions Inc.

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Keywords

    none

    Install

    npm i coveoforsitecore-search-ui

    DownloadsWeekly Downloads

    295

    Version

    0.56.8

    License

    ISC

    Unpacked Size

    2.94 MB

    Total Files

    342

    Last publish

    Collaborators

    • coveoit
    • npmcoveord