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

@ebisearch/baseline-portal

v0.0.17

Published

This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.2.0.

Downloads

376

Readme

BaselinePortal

This library was generated with Angular CLI version 16.2.0.

Importing components

Header

  1. Import configuration tokens into the app.component.ts file (replacing existing header component import):
   import {
  HeaderComponent,
  CATEGORY_CONFIG,
  GLOBAL_SEARCH_CONFIGURATION,
  INAVIGATION_DATA,
  INAVIGATION_ITEM
   } from '@ebisearch/baseline-portal';
  1. Create categories with the following schema:
export interface CategoryConfiguration {
  id: string;
  name: string;
  description: string;
  url?: string;
  defaultDomainId?: string;
  domains?: DomainConfiguration[];
  examples?: string[];
  dropdown?: boolean;
}

export interface DomainConfiguration {
  id: string;
  domainId: string;
  name: string;
  prefixedQuery?: string;
  examples?: string[];
  default?: boolean;
}

export interface GlobalSearchConfiguration {
  title: string,
  subTitle: string,
  searchExamples: string[]
}
  1. Create Navigation items with the following schema:
export interface INavigationLink {
  external: boolean;
  value: string;
  queryParams?: Params;
}

export interface INavigationItem {
  text: string;
  label?: string;
  link?: INavigationLink;
  items?: INavigationItem[];
  googleAnalyticsRegion?: string;
  renderAsChild?: boolean;
  displayIf?: () => boolean;
  onClick?: () => void;
}

export interface INavigationData {
  googleAnalyticsRegion: string;
}
  1. Import configurations and provide them to the header library component
import {
  categoriesConfiguration,
  globalSearchConfiguration,
  iNavigationData,
  iNavigationItems,
} from "./search/search-configuration";
//...
@Component({
//...
imports: [ HeaderComponent, RouterOutlet, FooterComponent ],
  providers: [
    {provide: CATEGORY_CONFIG, useValue: categoriesConfiguration},
    {provide: GLOBAL_SEARCH_CONFIGURATION, useValue: globalSearchConfiguration},
    {provide: INAVIGATION_DATA, useValue: iNavigationData},
    {provide: INAVIGATION_ITEM, useValue: iNavigationItems}
  ]
})
  1. Replace tags in html file:
<lib-header></lib-header>

Injection tokens

| Token | Interface | |-----------------------------|:-------------------------:| | CATEGORY_CONFIG | CategoryConfiguration | | GLOBAL_SEARCH_CONFIGURATION | GlobalSearchConfiguration | | INAVIGATION_DATA | INavigationData | | INAVIGATION_ITEM | INavigationItem | | NOT_FOUND_PAGE_CONFIGURATION | PagesConfiguration |

Code scaffolding

Run ng generate component component-name --project baseline-portal to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project baseline-portal.

Note: Don't forget to add --project baseline-portal or else it will be added to the default project in your angular.json file.

Build

Run ng build baseline-portal to build the project. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build baseline-portal, go to the dist folder cd dist/baseline-portal and run npm publish.

Running unit tests

Run ng test baseline-portal to execute the unit tests via Karma.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.