beer-library-package v1.0.1

Team B.E.E.R (11) Web Components

Our goal for this project is to create an extensible library of vanilla and lit-element web-components. Click on our logo above to head over to our team page.

Getting Started

NPM

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

npm install --save beer-library

Prerequisites

If you want to install Testcafe globally,

npm install -g testcafe

If locally,

npm install --save-dev testcafe

To install ESLint

npm install eslint

To install Documentation.js

npm install documentation

Installing

In order to install all dependencies of Team B.E.E.R Library

npm install

Running the tests

To run tests on the raw components

npm run raw-test

To run tests on the LitElement components

npm run port-test

To generate the docs

npm run docs:build

And coding style tests

For details on our coding style guidelines, check out .eslintrc.json.

For enforcing our coding style guidelines, we use ESLint.

npm run lint

File Structure

For details on how our files are organized, check out our public notion resource.

https://www.notion.so/File-Structure-9f3e436dd367401a91d4254f48c4a5b9

Built With

• Lit Elements - A simple base class used to build beer-button-lit and beer-notification-lit
• NPM - package manager used
• ESLint - Linting utility used

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.

Team Members

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

We would like to thank Professor Powell of CSE 112 for the guidance he gave us and all the TAs who assisted us in reaching this far. We would also like to thank Peter for giving us a glimpse of what we will see in the future as Software Engineer.