moji-ui v0.0.0-canary.0

Moji 🐰

Moji React UI Framework by IDwall

• React 16
• Documentation (WIP)
• View Live Storybook
• Presentational React components
• Dedicated UI Development Environment with React storybook
• Easy adoption because of CSS-in-JS
• Easy Server Side Rendering (SSR) and automatic hydration
• Interested in Moji? Come work for IDwall!
• Brought to you by IDwall

Core values

Moji is built on the belief that you can never predict all future requirements, only prepare for it. Instead of creating fixed configurations that work today, Moji promotes building systems that anticipate new and changing design requirements.

Moji is built on the belief that things should work out of the box with smart defaults, but also offer full control when needed.

Moji is built on the belief that using Moji and contributing to Moji should be a pleasant experience. We prioritize documentation and all the tools for a solid developer experience. We advocate respect and inclusivity in our writings and interactions.

Install and use components

Moji is made up of multiple components and tools which you can import one by one. All you need to do is install the moji-ui package:

$ yarn add moji-ui
# or
$ npm install --save moji-ui

A working version, assuming you are using something like Create React App, might look like this:

import React from 'react'
import ReactDOM from 'react-dom'
import { Button } from 'moji-ui'

ReactDOM.render(
	<Button>I am using Moji!</Button>,
	document.getElementById('root')
)

Contributing to Moji

Step 1. Configuring your editor

If you are using Atom, make sure to install the prettier-atom, linter and linter-xo packages.

All the configuration for prettier and xo is in the package.json. You shouldn't have to configure things separately, please file a issue if there's a problem.

Step 2. Get storybook up and running

To actually start seeing the components you have to run React Storybook:

$ yarn dev

Step 3. Learn more in the Contributing guide

Please take a look at the contributing guide and roadmap to better understand what to work on.

Scripts explained

Inside the package.json there are a bunch of scripts that this repo uses to run the project in development and to build the project.

Below you can read a description of each script.

yarn dev

Starts the development React Storybook.

yarn test

Lints the JavaScript files using XO and then runs the unit tests using AVA.

yarn build

Builds all of the JavaScript files using Babel.

yarn release

Releases new version of Moji (requires np to be installed globally).

yarn create-package

This command scaffolds a package with no specific boilerplate. It's useful for creating utilities.

For the following command:

yarn create-package utils

The following file tree will be generated:

/src/utils
├── /src/
└── index.js

yarn create-package:components

This command scaffolds a package with React component(s) boilerplate. You can pass one or more components to this command.

For the following command:

yarn create-package:components typography text heading

The following file tree will be generated:

/src/typography
├── /src/
|   │── text.js
|   └── heading.js
├── /stories/
│   └── index.stories.js
└── index.js

yarn run create-docs-template

For the following command:

$ yarn run create-docs-template layers Pane Card

The following file tree will be generated:

/src/layers/docs
├── index.js
└── /examples/
    ├── Pane-basic.example
    └── Card-basic.example

Manual steps for docs

This yarn run create-docs-template script is far from perfect and still requires manual steps. This includes:

• Making sure to use the right examples and write some docs.
• Configure docs/utils/get-component.js
• Configure docs/components/components-sidebar.js

Contributors 🎉

This project is maintained by IDwall

Please take a look at the contributing guide and roadmap to better understand what to work on.

Respect earns Respect 👏

Please respect our Code of Conduct, in short:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

FAQ

License

Moji is released under the MIT license.

Copyright © 2018 idwall.co.