https://github.com/Skyscanner/backpack-foundations

The foundational repo for Backpack platforms
https://github.com/Skyscanner/backpack-foundations

Last synced: 3 months ago
JSON representation

The foundational repo for Backpack platforms

• Host: GitHub
• URL: https://github.com/Skyscanner/backpack-foundations
• Owner: Skyscanner
• License: apache-2.0
• Created: 2020-01-27T13:54:58.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T15:24:12.000Z (6 months ago)
• Last Synced: 2024-05-21T12:33:23.572Z (6 months ago)
• Language: JavaScript
• Size: 14.3 MB
• Stars: 8
• Watchers: 30
• Forks: 9
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-Design-Tokens - Backpack

README

        
# Backpack Foundations

This repo contains common design system elements that are shared across Skyscanner platforms. These include but are not limited to icons and tokens e.g. colours, typography etc.

[![Build Status](https://github.com/Skyscanner/backpack-foundations/workflows/Foundations%20CI/badge.svg)](https://github.com/Skyscanner/backpack-foundations/actions)

## Table of contents

* [Structure](#structure)

* [Contributing](#contributing)

* [Contact](#contact)

* [Changelog](./CHANGELOG.md)

## Structure

This repo is broken down into the following [packages](/packages):

### `bpk-foundations-common`

All tokens that are common across all platforms, broken down into two parts:

`base/` – tokens that are consistent across all platforms, like colours or animations. This could expand in the future as we align more across platforms.

`app/` – tokens that are shared across iOS and Android.

### `bpk-foundations-`

These specific packages target any tokens that are only applicable to them, e.g. breakpoints for web or elevations for Android.

These packages inherit the `bpk-foundations-common` tokens and export them through each `aliases.json` file, so they can be added to the platform alongside their specific tokens.

## Usage

### Installing packages

```sh

npm install @skyscanner/[package-name] --save

```

**Note:** You should not install the `bpk-foundations-common` package as this is consumed within each platform-specific package and serves tokens directly.

## Contributing

To contribute please see [contributing.md](CONTRIBUTING.md).