Skip to content
/ core Public

🌶️ A themable and extensible React UI library, ready to use out of the box

License

Notifications You must be signed in to change notification settings

spicy-ui/core

Repository files navigation

spicy-ui

🌶️ A themable and extensible React UI library, ready to use out of the box

npm Dependencies Dev Dependencies

Basic usage

Install Spicy UI to your React project with npm i @spicy-ui/core styled-components

import React from 'react';
import { Button, ThemeProvider } from '@spicy-ui/core';

export const App = () => (
  <ThemeProvider>
    <Button>Hey hot stuff 🌶️</Button>
  </ThemeProvider>
);

See the documentation for components, theming and advanced usage.

Issues and Bugs

If you happen to find any, please report them here so they can be squashed.

Development and Contributing

Pull the repo and then install dependencies with npm.

In the root directory, use npm run start:storybook to run Storybook on localhost:9000

See the package.json for other scripts such as clean, test and lint.

License

MIT, see the LICENSE file.