README.md

YouSee DNA

A framework for building YouSee branded websites and applications.
YouSee DNA documentation · YouSee DNA on GitHub

Table of contents

• Install
• Contents
• Browser Support
• Documentation
• Local Documentation

Install

• Install with npm: npm i @youseedk/dna
• Install with yarn: yarn add @youseedk/dna

Contents

In the downloaded package (found in node_modules/@youseedk/) you'll find the following directories:

dna/
├── css/
│   ├── base
│   ├── elements
│   ├── icons
│   ├── layout
│   ├── settings
├── scss/
├── svg/
├── ys-bundle.css
└── ys-bundle.min.css

The package is designed for two use cases:

1. "As is" — you use ys-bundle.min.css which contains all YouSee elements and layout settings.
2. "Custom" - you pick and mix what elements, svg files, font files etc. are needed and include them in a setup of your own choosing.

If you choose option 2, "Custom", please be aware that it is required that you include ys-base.css before including any other elements.

For further documentation, please visit the documentation site

CDN

It is also possible to load the bundled css files from a CDN: <link rel="stylesheet" type="text/css" href="https://unpkg.com/@youseedk/dna/ys-bundle.min.css" /> will always load the latest version.

If a specific version is needed, insert the version number into the URL, ie.: <link rel="stylesheet" type="text/css" href="https://unpkg.com/@youseedk/dna@1.0.0/ys-bundle.min.css" /> will load version 1.0.0.

Browser Support

Please visit the documentation site

Documentation

YouSee DNA's documentation is built with Fractal, deployed on GitHub Pages using Travis CI.

Local documentation

Clone the repo:

git clone https://github.com/yousee.dk/dna.git

After cloning the repository run the following command to install node modules

$ npm ci

Running the project

$ npm start

That will run the project in development mode and will watch the files for changes. The command will also print the hostname and port for where the server is runnning.