Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webcomponents/webcomponents.org
Home of the web components community
https://github.com/webcomponents/webcomponents.org
web-components
Last synced: about 1 month ago
JSON representation
Home of the web components community
- Host: GitHub
- URL: https://github.com/webcomponents/webcomponents.org
- Owner: webcomponents
- License: apache-2.0
- Created: 2016-06-30T00:36:06.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T18:18:20.000Z (about 2 months ago)
- Last Synced: 2024-10-01T02:41:21.873Z (about 2 months ago)
- Topics: web-components
- Language: TypeScript
- Homepage: https://www.webcomponents.org
- Size: 6.12 MB
- Stars: 363
- Watchers: 28
- Forks: 85
- Open Issues: 132
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# webcomponents.org
A new version of webcomponents.org
The currently deployed version is on the `old-site` branch.
See [DESIGN.md](./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:
```bash
npm ci
```
2. Run tests:
```bash
npm test
```
3. Start everything in development mode and watch for changes:
```bash
npm start --watch
```
4. Visit [`http://localhost:6451/bootstrap-packages`](http://localhost:6451/bootstrap-packages) to bootstrap the database with a default set of elements.
5. Visit [`http://localhost:5450/catalog`](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:
```sh
npm run start:docker
```
## Ports
We use the following port scheme for consistency and to prevent collisions:
- [`localhost:5450`](http://localhost:5450): site-server in dev mode
- [`localhost:5451`](http://localhost:5451): site-server in prod mode
- [`localhost:5452`](http://localhost:5452): site-server in docker
- [`localhost:5452`](http://localhost:5453): site-server gcloud proxy
- [`localhost:6451`](http://localhost:6451): catalog-server
- [`localhost:6452`](http://localhost:6452): catalog-server in docker
- [`localhost:6452`](http://localhost:6453): catalog-server gcloud proxy
- [`localhost:7450`](http://localhost:7450): firestore-emulator