npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@cryb/borealis

v1.0.7

Published

The official CSS framework for Cryb

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

darnfishdarnfishjedayoshijedayoshiwilliamsthingwilliamsthing

Keywords

Readme

Cryb OSS

Borealis — CSS framework

GitHub contributors License Patreon Donate

Docs

Info

@cryb/borealis is the CSS framework for all Cryb web apps.

Borealis is built to unify UI design across our web app, admin panel, landing page and any future web apps we build. It is not intended to be used in non-Cryb applications, but feel free to do so.

It uses Sass as its main preprocessor.

Features

  • Mobile support
  • Dark mode support

Status

@cryb/borealis has been actively developed since December 2019.

Installation

This library is available on the NPM registry. To install, run:

npm i @cryb/borealis --save

If you're using Yarn, run:

yarn add @cryb/borealis

CDN

@cryb/borealis is also available through unpkg and jsdelivr.

Note: you only need to include one CSS file. Below we include both minified and unminified CDN links—we recommend that you use the minified version

unpkg

# Minified
https://unpkg.com/@cryb/borealis@latest/css/borealis.min.css

# Uminified
https://unpkg.com/@cryb/borealis@latest/css/borealis.css

jsdelivr

# Minified
https://cdn.jsdelivr.net/npm/@cryb/[email protected]/css/borealis.min.css

# Unminified
https://cdn.jsdelivr.net/npm/@cryb/[email protected]/css/borealis.css

Usage

Compiled CSS can be found under @cryb/borealis/dist/ as borealis.css and borealis.min.css.

We recommend you use borealis.min.css in production environments.

HTML

Simply link Borealis as you would any other CSS file:

<head>
	<link rel="stylesheet" href="css/borealis.min.css">
</head>

Borealis is also offered through a CDN. While we recommend you download Borealis locally, you can use either unpkg or jsdelivr.

unpkg

<!-- Minified (production, recommended) -->
<link rel="stylesheet" href="https://unpkg.com/@cryb/borealis@latest/css/borealis.min.css" />

<!-- Unminified (development) -->
<link rel="stylesheet" href="https://unpkg.com/@cryb/borealis@latest/css/borealis.min.css" />

jsdelivr

<!-- Minified (production, recommended) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@cryb/[email protected]/css/borealis.min.css" />

<!-- Unminified (development) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@cryb/[email protected]/css/borealis.css" />

Nuxt.js

After installation, Borealis can be easily integrated into a Nuxt.js project through nuxt.config.js. See the example below:

export default {
	css: [
		'@cryb/borealis'
	]
}

Codebase

The codebase for @cryb/borealis is written in Sass.

Folder Structure

cryb/borealis/
├──┐ src # Uncompiled Sass
│  ├── components # Buttons, boxes, etc
│  ├── pages # Styles for pages
│  └── utils # Static variables
├─── dist # Compiled CSS
└──┐ examples # Pages to test compiled CSS
   └── assets # Assets for example pages

First time setup

First, clone the @cryb/borealis repository locally:

git clone https://github.com/crybapp/borealis.git

Installation

You also need to install the required dependencies by running yarn.

Compiling CSS locally

To run @cryb/borealis in development mode, run yarn dev. This mode will watch for changes on .sass files under dist/ and then compile accordingly.

Once you have finished your changes, run yarn build to fully compile to dist/. You should do this before committing.

Questions / Issues

If you have an issues with @cryb/borealis, please either open a GitHub issue, contact a maintainer or join the Cryb Discord Server and ask in #tech-support