0.1.0-alpha.2 • Published 1 month ago

@stritech/strive-ui v0.1.0-alpha.2

Weekly downloads
-
License
AGPL-3.0-or-later
Repository
github
Last release
1 month ago

A robust UI library that gives you the ability to build out your own design system, but without all the hassle.

✨ Features

  • 🎁 High-quality React components out of the box.
  • ⚔️ Written in TypeScript with well defined and predictable types.
  • 🎨 Expandable theme and design system customization with SASS variables.

🌍 Environments

  • Modern browsers
  • Server-side Rendering

🎁 Install

$ npm install @stritech/strive-ui
$ yarn add @stritech/strive-ui

🔨 Usage

import React from "react";
import { Button } from "@stritech/strive-ui";

const App = () => (
  <>
    <Button variant="primary">Click Me!</Button>
  </>
);

⌨️ Development

Clone and run locally
$ git clone git@github.com:Striving-Technologies/strive-ui.io.git
$ cd strive-ui.io
$ npm install
$ npm run storybook

A new tab should automatically open in the browser on port 6006, if not, open your browser and visit http://127.0.0.1:6006 or http://localhost:6006.

Testing locally (in a separate project)

In the Strive UI directory run:

$ npm link

Navigate to the application you want to use for the test and run:

$ npm link @stritech/strive-ui

You should now be able to import and use components as shown above.

🤝 Contribution

There are tons of ways you can contribute, and we're happy to accept all. Please checkout our guide to contributing here. We can't wait to see what you've got for us.