Onboard Shipyard 🚢

Our future proof Web Components build with TypeScript and Lit.

Usage 👷🏻‍♂️

Install the library:

npm i onboard-shipyard

And import the components where needed:

import 'onboard-shipyard/card';
import 'onboard-shipyard/map';

<ob-card>
  <h3 slot="header">Look at this map!</h3>

  <p>It's amazing!</p>

  <ob-map></ob-map>
</ob-card>

Documentation 📖

The interactive documentation is created with Docsify and viewable online at:

• https://unpkg.com/onboard-shipyard@latest/docs/index.html

Or locally when developing:

• http://localhost:5000

Development 🛠

1. Clone this repository.
2. Install the dependencies with npm install.
3. For development run npm run dev.
4. For the deployment build run npm run build.

Source files

The components and related files are located in src.

Documentation

To add and document a component:

• Create a component and export it from shipyard.ts.
• Add a <component>.md file to docs/components.
• And a link to the _sidebar.md.

npm link

When working simultaneously on an application and this component library it's best to use npm link:

• https://docs.npmjs.com/cli/v7/commands/npm-link
• https://medium.com/dailyjs/how-to-use-npm-link-7375b6219557

Happy hacking!

Release a new version 🏷

You can release a new version with the npm version <patch|minor|major|prerelease> command.

This will:

• Build the project.
• Add a git tag.
• Push the branch to the repository.

The build server will then publish a new version to npm.