https://github.com/crybapp/borealis
CSS framework for Cryb
https://github.com/crybapp/borealis
css-framework library
Last synced: about 12 hours ago
JSON representation
CSS framework for Cryb
- Host: GitHub
- URL: https://github.com/crybapp/borealis
- Owner: crybapp
- License: mit
- Created: 2019-11-23T16:52:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T13:53:50.000Z (about 3 years ago)
- Last Synced: 2025-10-04T07:53:55.601Z (4 months ago)
- Topics: css-framework, library
- Language: Sass
- Homepage:
- Size: 929 KB
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
**@cryb/borealis** — _CSS framework & Common Styles_
[](https://github.com/crybapp/borealis/graphs/contributors) [](https://github.com/crybapp/borealis/blob/master/LICENSE) [](https://patreon.com/cryb) [](https://discord.gg/xdhEgD5)
## Docs
* [Info](#info)
* [Features](#features)
* [Status](#status)
* [Installation](#installation)
* [CDN](#cdn)
* [Usage](#usage)
* [HTML](#html)
* [Nuxt.js](#nuxt.js)
* [Codebase](#codebase)
* [Folder Structure](#folder-structure)
* [First time setup](#first-time-setup)
* [Installation](#installation)
* [Compiling CSS locally](#compiling-css-locally)
* [Questions / Issues](#questions--issues)
## 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](https://sass-lang.com/) 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](https://www.npmjs.com/package/@cryb/borealis). To install, run:
```bash
npm i @cryb/borealis --save
```
If you're using [Yarn](https://yarnpkg.com), run:
```bash
yarn add @cryb/borealis
```
### CDN
`@cryb/borealis` is also available through [unpkg](https://unpkg.com/) and [jsdelivr](https://www.jsdelivr.com/).
**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
# Unminified
https://unpkg.com/@cryb/borealis@latest/css/borealis.css
```
#### jsdelivr
```
# 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
```
## 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:
```html
```
Borealis is also offered through a CDN. While we recommend you download Borealis locally, you can use either [unpkg](https://unpkg.com/) or [jsdelivr](https://www.jsdelivr.com/).
#### unpkg
```html
```
#### jsdelivr
```html
```
### Nuxt.js
After installation, Borealis can be easily integrated into a Nuxt.js project through `nuxt.config.js`. See the example below:
```js
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](https://discord.gg/xdhEgD5) and ask in `#tech-support`.