@devopness/ui-react

Devopness UI - React

The official Devopness UI components for React

Usage

Install/Upgrade

Use your favourite package manager to install Devopness UI as a dependency of your project:

# Using npm
npm install @devopness/ui-react

# Using yarn
yarn add @devopness/ui-react

✍️ Contributing

Improvements and contributions are highly encouraged! 🙏👊

See the contributing guide for details on how to participate.

All communication and contributions to Devopness projects are subject to the Devopness Code of Conduct.

Not yet ready to contribute but do like the project? Support Devopness with a ⭐!

Dependencies

This component library uses:

• ⚛️ React — JavaScript library for user interfaces
• 📖 Storybook — Frontend workshop for UI development
• 💅 Styled Components - CSS-in-JS library for styling components
• ⚡ Vite — The build tool for the web
• 📦 SWC (Speedy Web Compiler) — Rust based compiler used to speed up Vite dev server
• 🧪 Vitest — Vite-native testing framework
• 🐙 React Testing Library - A light-weight solution for testing React components

As well as a few others tools configured:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Development & Testing

Installing on Linux or macOS systems.

1. Navigate to the project directory

cd packages/ui/react/

2. Install missing dependencies

This command will install all modules listed as dependencies in package.json.

npm install

3. Build UI package

npm run build

4. Run tests

npm run test

5. Run storybook

npm run storybook