@apaq/stallion NPM

Stallion

A forward-thinking library of web components.

Works with all frameworks 🧩
Works with CDNs 🚛
Fully customizable with CSS 🎨
Includes an official dark theme 🌛
Built with accessibility in mind ♿️

Designed in Scandinavia by Apaq.

Stallions 🥾

Stallions, or "Stallion developers," can use this documentation to learn how to build Stallion from source. You will need Node >= 12.10.0 to build and run the project locally.

You don't need to do any of this to use Stallion! This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Stallion.

What are you using to build Stallion?

Components are built with Stencil, a compiler that generates standards-based web components. The source code is a combination of TypeScript + JSX (TSX). Stylesheets are written in SCSS.

The build is done through a combination of Stencil's CLI and a handful of custom scripts.

Forking the Repo

Start by forking the repo on GitHub, then clone it locally and install dependencies.

git clone https://github.com/YOUR_GITHUB_USERNAME/stallion
cd stallion
npm install

Developing

Once you've cloned the repo, run the following command.

npm run start

This will spin up the Stallion dev server. Note that the dev server requires ports 4000, 4001, and 4002 to be available.

After the initial build, a browser will open at http://localhost:4000.

Hot module reloading (HMR) is enabled for components, so changes will instantly reflect in the browser as you work. The documentation is powered by Docsify, which uses raw markdown files to generate pages. As such, no static files are built for the docs. Unfortunately, changes to documentation pages will trigger a page refresh (no HMR).

Building

To generate a production build, run the following command.

npm run build

Creating a new release

When a new release is to be created, the following steps needs to be followed.

At https://github.com/apaq/stallion, locate the releases view (at the right side of the project root). Then do the following:

Click "draft a new release"
Enter the new tag name as vNEXT_VERSION (fx. v1.0.1)
Enter version as the title (fx. 1.0.1)
Optionally add details about contents in the release in the description area.
If the version is a prerelease, then check the "Set as a prerelease" checkbox.
Click Publish

Contributing

Stallion is an open source project and contributions are encouraged! If you're interesting in contributing, please review the contribution guidelines first.