Git Product home page Git Product logo

webcomponents.org's Introduction

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:

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.