Skip to content

Latest commit

 

History

History
50 lines (26 loc) · 1.59 KB

README.md

File metadata and controls

50 lines (26 loc) · 1.59 KB

Oryx-ui

Welcome to the Oryx-ui project! This is a React component library that harnesses the power of Vite for fast and efficient development. The components are based on the radix-ui library and integrated with a custom theming system.

Getting Started

Prerequisites

Make sure you have Node.js installed on your machine.

Installation

npm install

Local Development

npm run dev

Visit http://localhost:3000 in your browser to view the app in development mode.

Production build

npm run build

Project Structure

/src: Contains the source code of the app. /themes/palettes: Contains configuration files for the theming system.

Components and Radix-UI

The components in this project are based on the radix-ui library, providing a solid foundation for building accessible and flexible React components. Be sure to check the radix-ui documentation for more details.

Tailwind

All the project and components use Tailwind!!

Theming System

This project integrates a custom theming system that allows you to customize the look and feel of the app to fit the needs of your project. Refer to the /themes directory for more information on how to configure and use the theming system.

The presets you find in themes/palettes are based on Radix-ui/colors, to obtain a comprehensive color system for designing beautiful, accessible websites and apps.

Issue Reporting

If you encounter issues or have suggestions, please open a new issue on GitHub Issues.

License

This project is distributed under the MIT license.