nogbase-ui 1.0.0

package/README.md

@@ -0,0 +1,61 @@
+# Nogbase UI
+
+`nogbase-ui` is the ported Nogbase design system package. It contains theme tokens, icons, layout primitives, display components, input controls, navigation components, and the main component Storybook catalog.
+
+## Usage
+
+Import package CSS once in the app entry:
+
+```ts
+import 'nogbase-ui/style.css';
+import 'nogbase-ui/theme-light.css';
+import 'nogbase-ui/theme-dark.css';
+```
+
+Wrap React surfaces with the theme and icon providers:
+
+```tsx
+import { IconsProvider } from 'nogbase-ui/display';
+import { ThemeProvider } from 'nogbase-ui/theme-constants';
+
+export const App = ({ children }: { children: React.ReactNode }) => (
+  <ThemeProvider colorScheme="light">
+    <IconsProvider>{children}</IconsProvider>
+  </ThemeProvider>
+);
+```
+
+## Building
+
+From the workspace root:
+
+```bash
+pnpm --filter nogbase-ui build
+pnpm --filter nogbase-ui build:individual
+```
+
+## Storybook
+
+Run the UI Storybook development server:
+
+```bash
+pnpm run ui:storybook
+```
+
+Default port:
+
+```text
+http://localhost:6007
+```
+
+Build the static Storybook:
+
+```bash
+pnpm run ui:storybook:build
+```
+
+## Notes
+
+- This package should remain the design-system layer.
+- App-engine behavior belongs in `nogbase-front`.
+- Remote front-component rendering behavior belongs in `nogbase-front-component-renderer`.