Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.08 KB

README.md

File metadata and controls

47 lines (32 loc) · 2.08 KB

libre-wc

a demo repository for Code4Lib 'Multisite Man(i)agement' workshop (slides available at osf (PDF) and google sheets)

Background

This repository was made for a 3-hour workshop presented at Code4Lib 2020.

It is not a functioning boilerplate meant to exemplify the full breadth or best practice for how you'd want to set this up in production. See open-wc for that.

For an example of something like this being used in real life, see bulib/bulib-wc. We're using web components there at a real library, at some bit of scale, across a number of platforms.

Description/Introduction

This is a very lightweight repository built to demonstrate as simply as possible some of the concepts and tools we're working with and demonstrate how they're used without any "magic".

It's very much of a skeleton right now, that we'll (hopefully) fill in during (and just after) the workshop so you'll be able to see the steps of building it up from very little.

Dependencies

Running this repository requires that node and npm have been installed

Usage

To get this repository going, clone it, install the dev-dependendencies, npm run start, and visit localhost:8000 :

$ cd path/to/projects
$ git clone https://github.com/atla5/libre-wc.git
$ cd libre-wc
$ npm install
$ npm run start

Invitation/How to Contact Me

If you have any questions about what you see, please don't hesitate to contact me.

You can do so in the 'Issues' tab of this repository, on the code4Lib slack as '@atla5', or the polymer slack as 'Aidan S'.