WeAreGenki/ui


A friendly UI framework which aims to be straightforward, intuitive, and high performance.

https://ui.wearegenki.com

License: Apache-2.0

Language: CSS

Keywords: css, css-grid, design-system, marko, postcss, vue, wearegenki


Build status Coverage status NPM version NPM version beta Licence

@wearegenki/ui

A friendly UI framework which aims to be straightforward, intuitive, and high performance. Uses modern and futuristic tools and approach. Intended to be used in Vue or Marko projects or as standalone CSS.

NOTE: This is currently a work in progress and is not recommended for production applications... unless you love living on the bleeding edge!

Overview

The framework is designed around the types of projects we do at We Are Genki — ecommerce, microsites, and next-gen web apps — but are flexible enough for any web design use.

Features:

  • semi-flat design
  • microinteractions
  • high performance
  • great developer experience

Technologies:

Documentation

To see live examples and the docs, visit ui.wearegenki.com.

Quick start

1. Install dependencies

# development configuration files only
yarn install -D "@wearegenki/ui" "@wearegenki/test" eslint stylelint jest puppeteer

# CSS + compilation only
yarn install "@wearegenki/css" \
  && yarn install -D "@wearegenki/postcss-config" postcss

# all Vue.js packages (includes CSS)
yarn install "@wearegenki/ui-vue" vue vue-router vuex \
  && yarn install -D "@wearegenki/ui" "@wearegenki/test-vue" vue-server-renderer vue-template-compiler postcss eslint stylelint jest

# all Marko.js packages (includes CSS)
yarn install "@wearegenki/ui-marko" marko \
  && yarn install -D "@wearegenki/ui" "@wearegenki/test-marko" marko-lasso postcss-lasso lasso postcss eslint stylelint jest

2. Copy config boilerplate

# get latest copy of the repository
git clone --depth 1 https://github.com/WeAreGenki/ui.git <TEMPORARY_LOCATION>

# copy configuration files
cp -r <TEMPORARY_LOCATION>/docs/examples/boilerplate-configs/. <YOUR_PROJECT_LOCATION>

See config boilerplate readme for more tips.

Browser compatibility

Because this framework uses CSS Grid Layout it's limited to browsers that support it, which currently include:

  • Chrome for Android 61
  • Android browser 56
  • iOS Safari 10.3
  • Chrome 57
  • Firefox 52
  • Safari 10.1
  • Edge 16
  • Opera 46

NOTE: Older browser compatibility via progressive fallback is planned and will be added in the near future.

Known issues

Builds are designed to run on *nix systems and may fail on Windows machines.

Changelog

See CHANGELOG.md.

Licence

@wearegenki/ui is an Apache-2.0 licensed open source project. See LICENCE.


© 2018 We Are Genki

Project Statistics

Sourcerank 9
Repository Size 3.64 MB
Stars 1
Forks 0
Watchers 1
Open issues 4
Dependencies 925
Contributors 2
Tags 21
Created
Last updated
Last pushed

Top Contributors See all

Max Milton Renovate Bot

Packages Referencing this Repo

genkiui
placeholder
Latest release 0.0.0 - Published - 1 stars
@wearegenki/ui-eslint
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.4.0-alpha.e41170bf - Updated - 1 stars
@wearegenki/vue-input-toggle
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/vue-link-preload
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.4.2 - Updated - 1 stars
@wearegenki/vue-input-select
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/marko-modal
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/ui-vue
We Are Genki UI meta package which bundles all Vue components
Latest release 0.6.1 - Updated - 1 stars
@wearegenki/vue-dropdown
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/test
Test suite presets for use in We Are Genki projects.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/icons
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/vue-directive-view
Vue custom directive to show/hide elements using opacity
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/vue-link-preloader
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/test-marko
Test suite presets for use in We Are Genki projects.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/ui-postcss
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.4.0-alpha.e41170bf - Updated - 1 stars
@wearegenki/vue-debug-breakpoints
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
@wearegenki/ui
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.7.0 - Updated - 1 stars
wag-ui
CSS + Vue based UI library
Latest release 0.0.0 - Published - 1 stars
@wearegenki/vue-input-dropdown
CSS Grid based CSS library + Vue.js framework
Latest release 0.2.0 - Updated - 1 stars
@wearegenki/ui-stylelint
A friendly UI framework which aims to be straightforward, intuitive, and high performance.
Latest release 0.4.0-alpha.e41170bf - Updated - 1 stars
@wearegenki/ui-build-postcss
CSS Grid based CSS library + Vue.js framework
Latest release 0.2.0-alpha.90335e50 - Published - 1 stars

Recent Tags See all

v0.12.0 April 25, 2018
v0.11.0 April 25, 2018
v0.10.0 April 08, 2018
v0.9.0 March 31, 2018
v0.8.0 March 31, 2018
v0.7.0 March 25, 2018
v0.6.2 March 24, 2018
v0.6.1 March 24, 2018
v0.6.0 March 24, 2018
v0.6.0-beta.0 March 24, 2018
v0.5.2 March 15, 2018
v0.5.1 March 15, 2018
v0.5.0 March 11, 2018
v0.4.2 February 02, 2018
v0.4.1 January 27, 2018

Something wrong with this page? Make a suggestion

Last synced: 2018-03-28 03:36:32 UTC

Login to resync this repository