Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1.73 KB

README.md

File metadata and controls

54 lines (35 loc) · 1.73 KB
Raw

Northlight

Northlight is an open source UI framework built by Mediatool. It is based on Chakra UI and uses design tokens, making it easy to customize the look and feel of your application.

Documentation

https://northlight.dev/guide

Local sandbox

To start up a local environment of the Northlight UI framework docs:

  1. Clone the repository.
  2. Navigate into the root directory.
  3. Run yarn.
  4. Open one teminal, navigate to the /docs directory, and run yarn nx dev.
  5. Open another terminal, navigate to the /framework directory, and yarn watch.
  6. Open a third terminal, navigate to the /docs directory and run yarn transpile:watch.

This will spin up a local environment at localhost:5173 (or the first available port after that).

Usage

To get started with Northlight, you will need to install the following packages from npm:

yarn add @northlight/ui

Once installed, you can then import the different components from Northlight into your application. Here is an example of a basic button component:

import { Button } from '@northlight/ui'

Components

Northlight comes with a number of components that you can use in your application. Here is a list of some of the components available:

  • Buttons
  • Inputs
  • Layouts
  • Typography
  • Icons
  • Modals

Contributing

Northlight is an open source project and we welcome contributions from the community. If you would like to contribute to the project, please visit our GitHub repository and submit a pull request.

License

Northlight is open source software released under the MIT license.

Northlight Icons is proprietary and will have to be purchased separately from UntitledUI (https://www.untitledui.com/icons)