swapi-person-card
v0.0.2
Published
Webcomponent swapi-person-card following open-wc recommendations
Readme
<swapi-person-card>
This webcomponent follows the open-wc recommendation.
Installation
npm i swapi-person-cardUsage
<script type="module">
import 'swapi-person-card/swapi-person-card.js';
</script>
<swapi-person-card></swapi-person-card>
<swapi-person-card id-person="2">
</swapi-person-card>
<swapi-person-card url="https://swapi.dev/api/people/3/">
</swapi-person-card>Attributes
|Name |Type |Example| Note | |--- |--- |--- |--- | |data|Object| {} | Only accepts schema for SWAPI | |id-person|Number | 1 , 2 | | |url | String| https://swapi.dev/api/people/3/ |If you use url and id-person, url has priority|
Linting with ESLint, Prettier, and Types
To scan the project for linting errors, run
npm run lintYou can lint with ESLint and Prettier individually as well
npm run lint:eslintnpm run lint:prettierTo automatically fix many linting errors, run
npm run formatYou can format using ESLint and Prettier individually as well
npm run format:eslintnpm run format:prettierTesting with Web Test Runner
To run the suite of Web Test Runner tests, run
npm run testTo run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run
npm run test:watchTooling configs
For most of the tools, the configuration is in the package.json to reduce the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
Local Demo with web-dev-server
npm startTo run a local development server that serves the basic demo located in demo/index.html
History
Hey! I love StarWars and I'm learning to code web components and share with the world!
Original documentation
Original documentation of Star Wars API by Paul Hallet
at https://swapi.co/documentation
Star Wars and all associated names are copyright Lucasfilm ltd.
Credits
- Erika Valdes
