https://github.com/phase2/outline

Tooling infrastructure for modern web component development.

https://github.com/phase2/outline

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary

Keywords

components components-library design-system hacktoberfest javascript lit lit2 outline storybook tailwindcss typescript web-components
Last synced: 5 months ago · JSON representation

Repository

Tooling infrastructure for modern web component development.

Basic Info
Statistics
  • Stars: 130
  • Watchers: 32
  • Forks: 27
  • Open Issues: 21
  • Releases: 0
Topics
components components-library design-system hacktoberfest javascript lit lit2 outline storybook tailwindcss typescript web-components
Created over 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

OutlineJS

Version GitPod License

Storybook Hosting

Netlify GitHub Pages Chromatic

Outline is a both a growing Web Component library as well as a toolkit for building out bespoke design systems for a wide variety of client and personal usages. Outline is based on the latest technologies and tools to help your component authoring experience and facilitate adoption in your organization.

More than a Design System

Outline is much more than just you run of the mill design system. Outline provides an added benefit on top of multiple similar libraries available.

  • Outline is a set of components
  • Outline is a set of tooling and technology to scaffold design systems for a multitude of projects
  • Outline is a set of rules for defining components
  • Outline is a set of rules for integrating components
  • Outline provides well curated documentation on many complex topics
  • Outline grows with internal lessons learned project after project here @phase2.

Outline and Outline design systems are built with many of the following notable tools:

  • Turborepo
  • Lit
  • TypeScript
  • CSS Custom Properties
  • Storybook
  • Postcss
  • TailwindCSS

Scaffolding a new Outline project

Outline is organized as a mono-repo and is available to use via NPM Packages and our CLI. The outline-cli simplifies the setup process using pre-defined templates available in the outline-templates package as guides on basic scaffolding of new Outline based projects.

Using NPX (recommended)

This method will load the latest version of the Outline CLI to cache, and prompt you when an update is available. This makes it easier than managing a local version to simply run outline init instead.

bash npx @phase2/outline-cli init

Global Installation

This method will require manually updating from time to time for the latest updates on your system. If you are using NVM appropriately, any version of node would need this installed. If you are using yarn, you can just install it once globally.

With NPM

bash npm install -g @phase2/outline-cli outline init

With Yarn

bash yarn global add @phase2/outline-cli outline init

Contributing to Outline

Detailed information regarding how to contribute to Outline development, can be found in CONTRIBUTING.md. Expect this information to be refined soon.

Please see Component Development Guide for information about developing for Outline.

Deploys by Netlify

Owner

  • Name: Phase2
  • Login: phase2
  • Kind: organization
  • Email: marketing+github@phase2.io
  • Location: United States of America

We make digital products that inspire, engage, and create impact.

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 1,187
  • Total Committers: 21
  • Avg Commits per committer: 56.524
  • Development Distribution Score (DDS): 0.316
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jake Strawn j****n@g****m 812
Dan Montgomery d****y@p****m 82
Ofer Shaal o****l@p****m 68
IMGoodrich i****h@p****m 61
Josh Mabry j****y@p****y 47
Gregg Shanefelt g****t@p****m 24
Chris Johnson c****n@p****m 22
Peter Schuelke p****e@p****m 21
bardleb b****s@p****m 14
Mike Potter m****e@e****m 9
Octane CI o****e@p****m 6
Ryan Beach r****h@p****m 6
Morgan l****n@g****m 4
Sarah P l****c@g****m 3
Dan Muzyka d****a@p****m 2
Ayana Powell a****l@p****m 1
Chris Clark c****k@p****m 1
Jeff Wax j****f@j****m 1
Joseph Ramos j****2@g****m 1
Josh Bromehead j****d@p****m 1
Tom Varughese 1****w 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 90
  • Total pull requests: 540
  • Average time to close issues: 7 months
  • Average time to close pull requests: 26 days
  • Total issue authors: 13
  • Total pull request authors: 16
  • Average comments per issue: 0.46
  • Average comments per pull request: 2.61
  • Merged pull requests: 330
  • Bot issues: 1
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • himerus (28)
  • mabry1985 (4)
  • shaal (3)
  • LeeMellon (2)
  • grshane (2)
  • scottalan (2)
  • sarahp (1)
  • tekante (1)
  • coderabbitai[bot] (1)
  • ccasals (1)
  • mike-potter (1)
  • laujonat (1)
  • ayanapowell (1)
Pull Request Authors
  • himerus (49)
  • shaal (28)
  • bardleb (7)
  • glitchgirl (6)
  • tekante (5)
  • LeeMellon (5)
  • mike-potter (4)
  • mabry1985 (3)
  • grshane (2)
  • drakkaroy (1)
  • damontgomery (1)
  • rvenegas94 (1)
  • cristoferespindola (1)
  • mattjcurtin (1)
  • JSchreff (1)
Top Labels
Issue Labels
For Review (41) MONOREPO MIGRATION (41) READY TO CODE (15) Requires Triage (13) tests (13) Difficulty: Average (12) Type: Bug (10) Good First Issue (10) Type: Feature Request (9) Difficulty: Low (5) Why: Reduce adoption friction (4) Internal Backport (2) Why: Improve performance (2) Severity: Low (2) Why: Increase standardization (2) Severity: Medium (2) Difficulty: High (1) Held for Review (1) Needs: Discussion (1) Decision Reached (1) Documentation (1) Severity: Critical (1) Type: Accessibility (1) Needs: More information (1) Severity: High (1)
Pull Request Labels
For Review (15) MONOREPO MIGRATION (13) Why: Reduce adoption friction (12) Why: Increase standardization (10) Held for Review (9) Severity: High (9) Needs Work (9) NEW PACKAGE (7) Type: Component Suggestion (7) Severity: Critical (7) Difficulty: Average (7) Ready for Review (6) Difficulty: High (6) Type: Controller Suggestion (6) Type: Feature Request (5) Why: Improve performance (5) CANNOT MERGE (4) Why: Improve security (3) Why: Update dependencies (3) Documentation (3) Type: Bug (2) Coding Standards (2) TESTS FAILING (2) Severity: Medium (1) Severity: Low (1) invalid (1) Codebase Update Needed (1) Difficulty: Low (1) Storybook (1)

Dependencies

.github/workflows/build.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • changesets/action v1 composite
  • chromaui/action v1 composite
  • crazy-max/ghaction-github-pages v3 composite
  • crazy-max/ghaction-github-status v3 composite
.github/workflows/dependencies.yml actions
  • actions/checkout v3 composite
  • actions/dependency-review-action v2 composite
package.json npm
  • @babel/core ^7.18.13 development
  • @changesets/cli ^2.24.3 development
  • @commitlint/cli ^17.4.0 development
  • @commitlint/config-conventional ^17.4.0 development
  • @open-wc/testing ^3.0.0-next.2 development
  • @storybook/addon-actions ^7.0.0-beta.33 development
  • @storybook/addon-essentials ^7.0.0-beta.33 development
  • @storybook/addon-links ^7.0.0-beta.33 development
  • @storybook/addon-postcss ^3.0.0-alpha.1 development
  • @storybook/builder-vite ^7.0.0-beta.33 development
  • @storybook/web-components ^7.0.0-beta.33 development
  • @storybook/web-components-vite ^7.0.0-beta.33 development
  • @types/estree ^0.0.47 development
  • @typescript-eslint/eslint-plugin ^5.0.0 development
  • @typescript-eslint/parser ^5.0.0 development
  • @web/test-runner ^0.13.15 development
  • @web/test-runner-browserstack ^0.4.2 development
  • @web/test-runner-playwright ^0.8.6 development
  • autoprefixer 10.4.0 development
  • chromatic ^6.11.3 development
  • esbuild ^0.15.7 development
  • eslint ^7.32.0 development
  • eslint-config-prettier ^7.2.0 development
  • eslint-plugin-import ^2.22.1 development
  • eslint-plugin-react ^7.23.0 development
  • eslint-plugin-storybook ^0.6.8 development
  • gaze ^1.1.3 development
  • husky ^8.0.3 development
  • jest ^26.6.3 development
  • jest-cli ^26.6.3 development
  • lint-staged ^10.5.4 development
  • lit-analyzer ^1.2.1 development
  • lit-html ^2.3.1 development
  • npm-run-all ^4.1.5 development
  • postcss 8.4.8 development
  • postcss-custom-properties 12.1.8 development
  • postcss-discard-comments 5.1.0 development
  • postcss-import 14.0.2 development
  • postcss-loader ^7.0.1 development
  • postcss-preset-env ^7.8.1 development
  • prettier ^2.0.4 development
  • prettier-plugin-tailwindcss ^0.1.7 development
  • react ^18.2.0 development
  • react-dom ^18.2.0 development
  • react-syntax-highlighter ^15.5.0 development
  • rimraf ^3.0.2 development
  • rsync ^0.6.1 development
  • storybook ^7.0.0-beta.33 development
  • svgo ^2.8.0 development
  • tailwindcss 3.0.0 development
  • ts-lit-plugin ^1.2.1 development
  • turbo ^1.2.16 development
  • vite ^3.0.0 development
packages/outline-accordion/package.json npm
  • @phase2/outline-core ^0.1.0
  • @phase2/outline-icon ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-admin-links/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-alert/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-breadcrumbs/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-button/package.json npm
  • @phase2/outline-core ^0.1.0
  • @phase2/outline-link ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-button-group/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-card/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-cli/package.json npm
  • @oclif/test ^2 development
  • @types/chai ^4 development
  • @types/fs-extra ^9.0.13 development
  • @types/mocha ^9.0.0 development
  • @types/node ^16.9.4 development
  • chai ^4 development
  • eslint ^7.32.0 development
  • eslint-config-oclif ^4 development
  • eslint-config-oclif-typescript ^1.0.2 development
  • globby ^11 development
  • mocha ^9 development
  • oclif ^3 development
  • shx ^0.3.3 development
  • ts-node ^10.2.1 development
  • tslib ^2.3.1 development
  • typescript ^4.4.3 development
  • @oclif/core ^1
  • @oclif/plugin-help ^5
  • @oclif/plugin-plugins ^2.0.1
  • @phase2/outline-storybook ^0.0.10
  • @phase2/outline-templates ^0.0.12
  • @types/inquirer ^8.2.1
  • chalk ^4.1.2
  • fs ^0.0.2-security
  • fs-extra ^10.1.0
  • inquirer ^8.2.4
packages/outline-cli/yarn.lock npm
  • 754 dependencies
packages/outline-code-block/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-container/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-core/package.json npm
  • @babel/plugin-proposal-class-properties ^7.13.0 development
  • @babel/plugin-proposal-decorators ^7.14.2 development
  • @commitlint/cli ^13.2.0 development
  • @commitlint/config-conventional ^13.2.0 development
  • @open-wc/testing ^3.0.0-next.2 development
  • @rollup/plugin-image ^3.0.0 development
  • @rollup/plugin-json ^6.0.0 development
  • @rollup/plugin-multi-entry ^6.0.0 development
  • @rollup/plugin-replace ^5.0.0 development
  • @rollup/plugin-terser ^0.4.0 development
  • @tailwindcss/aspect-ratio ^0.4.0 development
  • @tailwindcss/forms ^0.4.0 development
  • @tailwindcss/typography ^0.5.0 development
  • @types/estree ^0.0.47 development
  • @types/react ^18.0.26 development
  • @typescript-eslint/eslint-plugin ^4.0.0 development
  • @typescript-eslint/parser ^4.0.0 development
  • @web/test-runner ^0.13.15 development
  • @web/test-runner-browserstack ^0.4.2 development
  • @web/test-runner-playwright ^0.8.6 development
  • @webcomponents/webcomponentsjs ^2.5.0 development
  • autoprefixer ^10.4.0 development
  • babel-loader ^8.2.2 development
  • babel-plugin-named-exports-order ^0.0.2 development
  • deepmerge ^4.2.2 development
  • eslint ^7.22.0 development
  • eslint-config-prettier ^7.2.0 development
  • eslint-plugin-import ^2.22.1 development
  • eslint-plugin-react ^7.23.0 development
  • gaze ^1.1.3 development
  • husky ^4.3.8 development
  • lint-staged ^10.5.4 development
  • npm-run-all ^4.1.5 development
  • postcss ^8.4.4 development
  • postcss-cli ^8.3.1 development
  • postcss-discard-comments ^5.1.0 development
  • postcss-loader ^5.2.0 development
  • postcss-preset-env ^7.0.0 development
  • prettier ^2.0.4 development
  • prettier-plugin-tailwindcss ^0.1.7 development
  • react ^18.2.0 development
  • react-dom ^18.2.0 development
  • react-syntax-highlighter ^15.5.0 development
  • rimraf ^3.0.2 development
  • rollup ^3.0 development
  • rollup-plugin-summary ^2.0.0 development
  • rollup-plugin-svg ^2.0.0 development
  • rollup-plugin-typescript2 ^0.34.1 development
  • rsync ^0.6.1 development
  • sinon ^13.0.2 development
  • svgo ^2.7 development
  • tailwindcss ^3.0.0 development
  • ts-lit-plugin ^1.2.1 development
  • typescript ^4.0.0 development
  • vite ^4.0.4 development
  • wait-on ^5.3.0 development
  • web-component-analyzer ^1.0.3 development
  • @phase2/outline-config ^0.0.1
packages/outline-docs/package.json npm
  • @phase2/outline-core ^0.1.0
  • tslib ^2.1.0
packages/outline-dropdown/package.json npm
  • @phase2/outline-button ^0.1.0
  • @phase2/outline-core ^0.1.0
  • @phase2/outline-icon ^0.1.0
  • @phase2/outline-link ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-examples/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-grid/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-heading/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-icon/package.json npm
  • @phase2/outline-core ^0.1.0
  • @phase2/outline-include ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-image/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-image-slider/package.json npm
  • @phase2/outline-core ^0.1.0
  • @splidejs/splide ^4.0.7
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-include/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-link/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-list/package.json npm
  • @phase2/outline-core ^0.1.0
  • @phase2/outline-heading ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0
packages/outline-modal/package.json npm
  • @phase2/outline-core ^0.1.0
  • lit ^2.3.1
  • tslib ^2.1.0