Evergreen Web Component Library

Overview

A library of simple web components built on top of Litr

Project Goals

Making development easier and providing example components to people new to Web Components.

Under Development

This repo and Project Evergreen itself are still young and maturing rapidly. The Project Evergreen GitHub organization project tracker captures the high level goals and next steps, with plans to keep adding those lessons learned as features and improvements to this repo.

🙏 Please feel free to contribute, we are always looking forward to meeting like minded developers to collaborate with!

Package Guidelines

Packages should be organized as follows:

src/
  eve-yourcomponent.js
  eve-yourcomponent.css
package.json
README.md

The package.json should contain:

  "name": "@evergreen-wc/eve-yourcomponent",
  "version": "0.0.4",
  "description": "Your component made with lit element",
  "main": "src/eve-yourcomponent.js",
  "license": "Apache-2.0",
  "publishConfig": {
    "access": "public"
  },

Publishing Packages

Make sure you commit all changes then run:

npx lerna publish

Select patch

Publishing Documentation

You need setup a git worktree for the gh-pages branch in a folder called dist

git worktree add dist gh-pages

Documentation components are in the docs folder. This folder is built with:

npm run gh-pages

then commit and push to gh-pages branch with:

cd dist
git add *
git commit -m "Updated documentation: updated button component usage" -S
git push origin gh-pages

License

Released under the Apache-2.0 License