README
Covid Minigame
Welcome to Covid Minigame web component! You can freely use this by embedding our component in your web project.
Demo
https://covid-minigame.netlify.app/
How to Use
There are three strategies we recommend for using web components built with Stencil.
Script tag
- Put a script tag similar to this
<script src='https://unpkg.com/covid-minigame@0.4.0/dist/stay-safe-game.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
Node Modules
- Run
npm install covid-minigame --save
- Put a script tag similar to this
<script src='node_modules/covid-minigame/dist/stay-safe-game.js'></script>
in the head of your index.html - Then you can use the element anywhere in your template, JSX, html etc
In a stencil-starter app
- Run
npm install covid-minigame --save
- Add an import to the npm packages
import covid-minigame;
- Then you can use the element anywhere in your template, JSX, html etc
How to Contribute
To start developing on this repository:
git clone https://github.com/Impostor-SC/covid-minigame.git
cd covid-minigame
and run:
npm install
npm start
To build the component for production, run:
npm run build
To run the unit tests for the components, run:
npm test
Need help? Check out our docs here.
Naming Components
When creating new component tags, we recommend not using stencil
in the component name (ex: <stencil-datepicker>
). This is because the generated component has little to nothing to do with Stencil; it's just a web component!
Instead, use a prefix that fits your company or any name for a group of related components. For example, all of the Ionic generated web components use the prefix ion
.