0.0.6 • Published 4 years ago

@turtlemint/turtlemint-ui v0.0.6

Weekly downloads
-
License
GPL-3.0
Repository
github
Last release
4 years ago

UI components for web - A React implementation

npm version NPM size npm downloads W3C Validation Netlify Status NPM license

✨ Features

  • A modern and fitting UI design system for startup web applications.
  • A set of high-quality React components out of the box.
  • Written in TypeScript with predictable static types.
  • The whole package of development and design resources and tools.

🖥 Environment Support

  • Modern browsers and Internet Explorer 9+ (with polyfills
IE / EdgeFirefoxChromeSafariOperaElectron
IE9, IE10, IE11, Edgelast 2 versionslast 2 versionslast 2 versionslast 2 versionslast 2 versions

📦 Install

npm i @turtlemint/turtlemint-ui --save
yarn add @turtlemint/turtlemint-ui

🔨 Usage

import { Button } from '@turtlemint/turtlemint-ui';
ReactDOM.render(<Button />, mountNode);

⌨️ Development

Use Gitpod, a free online dev environment for GitHub.

Open in Gitpod

Or clone locally:

$ git clone git@github.com:turtlemint/turtlemint-ui.git
$ cd turtlemint-ui
$ yarn install
$ yarn workspace @turtlemint/turtlemint-ui run dev

It should spin up a browser automatically. If not, open your browser and visit http://127.0.0.1:5555

🤝 Contributing PRs Welcome

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues.