npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@coveo/angular

v1.36.10

Published

Coveo schematic for angular

Downloads

880

Readme

@coveo/angular

The @coveo/angular package contains the necessary components to set up a search page using Coveo Headless and Angular Material with the Angular CLI.

If you want to create a new Coveo Headless-powered search page with the Angular web framework from scratch, it is simpler to use the coveo ui:create:angular command in the Coveo CLI. The Coveo CLI will handle a lot of complexity for you. Calling the @coveo/angular package directly from the Angular CLI should rather be done to help you integrate a search page to an already existing Angular project.

Installation

To add a Coveo Headless-powered search page using Material Angular to an existing Angular project, execute the following steps:

  • Run ng add @coveo/angular --org-id=<org-id> --api-key=<api-key>, where you replace <org-id> by the unique identifier of your Coveo organization, and <api-key> by an API key granting the impersonate privilege in the target organization.
  • Answer the questions prompted in your terminal to configure your interface styling.
  • In your project, navigate to the new server folder. This is an Express server which generates Coveo search tokens.
  • The folder should contain a .env.example file. Create a copy of that file and rename it .env.
  • In that new .env file, replace all placeholder variables (<...>) by the proper information for your organization. For more involved configurations, you can modify the request parameters used in the middlewares/searchToken.ts file.
  • You can now go back to the root directory of your project and serve it by running ng serve.

Contributing

Component schematics

TODO

Development

TODO

Testing

To test the schematic locally, install @angular-devkit/schematics-cli globally and use the schematics command-line tool. That tool mimics generate and add commands of the Angular CLI.

Check the documentation with

schematics --help

First of all, create a new project:

ng new my-test-app --routing --style css

Make sure to link your local schematic to the project you want to use it in.

cd my-test-app
npm link /path/to/coveo-cli/packages/ui/angular

You can also use npm pack in your schematics project, then npm install /path/to/artifact.tar.gz in your Angular project. This mimics npm install more than npm link.

Run your schematic

schematics @coveo/angular:headless-engine --org-id<org-id> --api-key=<api-key> --dry-run

Unit Testing

npm run test will run the unit tests, using Jasmine as a runner and test framework.

Publishing

To publish, simply do:

npm run build
npm publish

That's it!