@universelabs/meta

Meta

Meta is an open source blockchain UI framework.
universe.engineering

Report bug · Request feature · Twitter · Medium · Slack

Table of contents

• Quick Start
• Status
• What's included
• Documentation
• Contributing
• Community
• Maintainers
• License

Quick start

Several quick start options are available:

• Download the latest release..
• Clone the repo: [e-mail]:universelabs/meta.git.
• Install with npm: npm install @universelabs/meta.
• Install with yarn: yarn add @universelabs/meta.

Status

What's included

Meta allows developers to quickly design and build quality user interfaces with little effort. With minimal adjustment, developers are able to create unique interfaces in less time. Think of the Meta as your design assistant.

Full-spectrum Color System

Meta contains a Full-spectrum Color System. Inspired by Palx and Open Color, Meta's Color System guides developers through fool proof color theming while providing them with a wide gamut of colors to choose from. No additional color tools necessary.

Responsive Ratio Type Scaling

Functional typography that implements complex type scaling with responsive & ratio scaling for greater readability out of the box. Meta provides complex typography and layout. No need to adjust font-size, line-height, margins, spacing. For those looking for greater flexibility, Meta is easily adjustable. With only a few values, developers can quickly test and deploy dramatic changes to their application.

Sketch Shared Library

Meta now comes with "Meta UI", a FREE Sketch Shared Library including Style Guide and Symbol resources. The library allows developers to quickly access Meta styles, colors, type, components, and more, within Sketch itself. Once installed, the Meta UI library syncs directly to Sketch Cloud. Users simply subscribe to Meta UI and Sketch will notify them of updates. No need to worry about version updates, etc.

To subscribe to Meta UI Sketch Shared Library

1. Sketch Shared Libraries require you to have Sketch installed on your Mac.
2. Once Sketch is installed, click Meta UI Sketch Shared Library which will take you to Meta UI in Sketch Cloud.
3. Next, click the ”Add Library to Sketch” button in the bottom right corner.
4. A modal window will pop up.
5. Click ”Add Library to Sketch.”
6. Meta UI is now syncing to your Sketch app.

To view Meta UI Style Guide and Symbols

1. Open Sketch App > Preferences > Libraries > Meta UI
2. Click the "eye" icon. This will open a preview.
3. Then click "Open with Sketch" in the top right corner of the preview window.

Meta is currently an extension of the Bootstrap framework. An easy to use Sass file that gets compiled with Bootstrap Theming. Blockchain componentry and other compatibility coming soon.

@universelabs/meta/
└── scss/
    └── meta.scss

Documentation

Meta is currently an extension of the Bootstrap framework. An easy to use Sass file that gets compiled with Bootstrap Theming.

There currently is no homepage to reference but will be coming soon. In the meantime, we recommend simply following the instructions below to get your version of the Meta Documentation up and running.

Running Meta Documentation locally

1. Quickly start by cloning the repository to your local machine git clone [e-mail]:universelabs/meta.git.
2. Ensure you have npm installed. npm comes bundled with Node.js. brew install node.
3. Add dependencies npm install.
4. Start the local client side server and run the app. The app will automatically open your web browser and navigate to http://localhost:3000/ for you npm start.

For detailed instructions on how to customize Meta and the Meta Documentation, visit Documentation.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All code should conform to the Code Guidelines.

Community

Get updates on Meta's development and chat with the project maintainers and community members.

• Follow @universelabs on Twitter.
• Join the official Universe Slack chat room.

For more details on how to get involved in the Universe Community visit the Universe Community page and learn more about events, roadmap, weekly & daily scrum, past weekly community scrum calls, and more...

Maintainers

Guy Lepage

• https://twitter.com/guylepage3
• https://github.com/guylepage3

License

By contributing your code, you agree to license your contribution under the MIT License.

This project was bootstrapped with Create React App v2 and uses the UI framework Bootstrap as it's foundational base.