Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 2.03 KB

README.md

File metadata and controls

64 lines (43 loc) · 2.03 KB

webcomponents.org

A new version of webcomponents.org

The currently deployed version is on the old-site branch.

See DESIGN.md for more information.

Packages

This monorepo contains several npm packages:

  • @webcomponents/catalog-server: A data-only backend that indexes npm packages and provides a GraphQL API into the database
  • @webcomponents/catalog-api: GraphQL schemas and TypeScript interfaces for the registry API.
  • @webcomponents/custom-elements-manifest-tools: Tools for working with Custom Element Manifests
  • @webcomponents/internal-site-content: An HTML client served by the frontend server
  • @webcomponents/internal-site-client: JavaScript for the site
  • @webcomponents/internal-site-server: A frontend server that serves the user-facing webcompoents.org site

Quick Start

  1. Install dependencies:

    npm ci
  2. Run tests:

    npm test
  3. Start everything in development mode and watch for changes:

    npm start --watch
  4. Visit http://localhost:6451/bootstrap-packages to bootstrap the database with a default set of elements.

  5. Visit http://localhost:5450/catalog and search for "button" to see example elements.

Docker

Using Docker locally gives you the most realistic simulation of a production environment:

npm run start:docker

Ports

We use the following port scheme for consistency and to prevent collisions: