@unimatrix-01/create-borg-ui
Version:
Borg UI - A modern React component library
61 lines (47 loc) • 1.52 kB
Markdown
# Borg UI Application
This is a [Borg UI](https://www.npmjs.com/package/@unimatrix-01/ui) application created with Vite, React, and TypeScript.
## Features
- 🚀 Built with Vite for fast development and building
- ⚛️ React 18 with TypeScript for type safety
- 🎨 Borg UI components and styling
- 📱 Responsive design with Tailwind CSS
- 🧭 React Router for navigation
- 🎯 Hot Module Replacement (HMR)
- 📦 Optimized production builds
## Getting Started
1. Install dependencies:
```bash
npm install
```
2. Start the development server:
```bash
npm run dev
```
3. Build for production:
```bash
npm run build
```
4. Preview production build:
```bash
npm run preview
```
## Project Structure
```
src/
├── components/ # React components
├── config/ # Application configuration
├── pages/ # Page components
├── App.tsx # Main application component
├── main.tsx # Application entry point
└── index.css # Global styles
```
## Customization
1. Update the app configuration in `src/config/app.config.ts`
2. Modify the theme colors in `src/index.css`
3. Add new routes in `src/App.tsx`
4. Create new components in the `src/components` directory
## Learn More
- [Borg UI Documentation](https://www.npmjs.com/package/@unimatrix-01/ui)
- [Vite Documentation](https://vitejs.dev/)
- [React Documentation](https://reactjs.org/)
- [Tailwind CSS Documentation](https://tailwindcss.com/)