Git Product home page Git Product logo

myuw-web-components.github.io's Introduction

MyUW Web Components Github pages

Cross-browser testing provided by:
BrowserStack

How to use the site

This site was developed as a proof of concept for a design system (with elements of a style guide, element library, framework, etc.) based on web components that are written in plain HTML, Javascript, and CSS. Some of the things you can do on the site include:

  • View best practices and usage guidance for individual components on their respective pages (see hamburger menu)
  • Use the home page to turn components off and on, tinker with their customizable features, and generate the code you need to use them (more detailed instructions are included in the site tour and on the home page)
  • Test the latest versions of all entries in the @myuw-web-components organization before deciding to adopt them

Running locally

Ensure you are able to run Jekyll on your command line. Clone the repository and run the following command from the root directory:

bundle exec jekyll serve

View the site at http://127.0.0.1:4000/

Contribution guidelines

Follow these basic rules when contributing to the site:

  • Clone the repo and do all your work on a new feature branch
  • Submit a merge request comparing the master branch to your feature branch
  • If your merge request goes unreviewed for more than a few days, notify a team member (see: pages/contacts.html)
  • Merge your own merge request once it has received at least one approval
  • If you are adding a new web component to the site:
    • Include it in the table of components on the home page (see: index.html)
    • Create a dialog on the home page to house the interactive/demo content (see: index.html)
    • Create a page in the /pages/ directory and link to it from the side navigation (see: _includes/header.html)
    • Ensure the proper import statements and markup templates are generated during code generation (see: src/scripts/interactions.js)

myuw-web-components.github.io's People

Contributors

davidmsibley avatar thevoiceofzeke avatar

Watchers

 avatar  avatar

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.