@cryb/borealis
Advanced tools
Borealis — CSS framework
@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.
@cryb/borealis has been actively developed since December 2019.
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
@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
# Minified
https://unpkg.com/@cryb/borealis@latest/css/borealis.min.css
# Uminified
https://unpkg.com/@cryb/borealis@latest/css/borealis.css
# Minified
https://cdn.jsdelivr.net/npm/@cryb/borealis@0.0.3/css/borealis.min.css
# Unminified
https://cdn.jsdelivr.net/npm/@cryb/borealis@0.0.3/css/borealis.css
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.
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.
<!-- 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" />
<!-- Minified (production, recommended) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@cryb/borealis@0.0.3/css/borealis.min.css" />
<!-- Unminified (development) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@cryb/borealis@0.0.3/css/borealis.css" />
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'
]
}
The codebase for @cryb/borealis is written in Sass.
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, clone the @cryb/borealis repository locally:
git clone https://github.com/crybapp/borealis.git
You also need to install the required dependencies by running yarn.
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.
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
FAQs
The official CSS framework for Cryb
We found that @cryb/borealis demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket has been recognized for the second consecutive year on the Fortune Cyber 60 list, which identifies the most significant venture-backed cybersecurity startups.
Security News
Python becomes GitHub's top language in 2024, driven by AI and data science projects, while AI-powered security tools are gaining adoption.
Security News
Dutch National Police and FBI dismantle Redline and Meta infostealer malware-as-a-service operations in Operation Magnus, seizing servers and source code.