https://github.com/makinox/makinox-ui

A special ui library
https://github.com/makinox/makinox-ui

hacktoberfest

Last synced: 21 days ago
JSON representation

A special ui library

• Host: GitHub
• URL: https://github.com/makinox/makinox-ui
• Owner: makinox
• License: mit
• Created: 2021-04-24T01:22:39.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-29T02:19:27.000Z (over 2 years ago)
• Last Synced: 2024-12-16T04:37:41.880Z (27 days ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage: https://makinox-ui.jesusbossa.dev/
• Size: 7.06 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @makinox/makinox-ui

A little UI library with basic components and near zero dependencies and hard configurations.

## Used

- Stiches

- Storyboard `Only for development`

- React `Only for storybook visualization, you can use any framework you like`

Link to [makinox-ui!](https://makinox-ui.jesusbossa.dev/)

## Usage

Just install with

```sh

npm i @makinox/makinox-ui

----

yarn add @makinox/makinox-ui

```

Add this to your code if you want the base colors

```ts

import '@makinox/makinox-ui/dist/colors.css';

```

If you want to use custom colors, just copy the format of the file and replace the colors, then import the content of the file to your code

Also, you can add the base layout classes like this if you want, this is optional

```ts

import '@makinox/makinox-ui/dist/index.css';

```

## Documentation

You can see the current components available in this web https://makinox-ui.jesusbossa.dev

Also, you can see these components locally running this command

```sh

yarn storybook

```

## Contributing

If you're interested in contributing to project, please read our [contributing docs](https://github.com/makinox/makinox-ui/blob/main/.github/CONTRIBUTING.md) **before submitting a pull request**.