@gbdev20053/simple-comp-ui
v0.0.0
Published
A modern React component library with shadcn/ui architecture
Maintainers
Readme
@gbdev20053/simple-comp-ui
A modern React component library with shadcn/ui architecture.
Installation
Option 1: From npm (Recommended)
# Install from npm
npm install @gbdev20053/simple-comp-ui
# Or with pnpm
pnpm add @gbdev20053/simple-comp-ui
# Or with yarn
yarn add @gbdev20053/simple-comp-uiOption 2: Direct from GitHub
# Install directly from GitHub
npm install github:gregbanks/simple-comp#main -- workspace=@simple-comp/ui
# Or with pnpm
pnpm add github:gregbanks/simple-comp#main --filter @simple-comp/uiOption 3: Local Development
# Clone the repo
git clone https://github.com/gregbanks/simple-comp.git
cd simple-comp
pnpm install
pnpm build
# Link locally
cd packages/ui
npm link
# In your other project
npm link @simple-comp/uiOption 4: Build and Pack
# In the simple-comp repo
cd packages/ui
pnpm build
npm pack
# This creates simple-comp-ui-0.0.0.tgz
# Copy to your other project and install
npm install ./simple-comp-ui-0.0.0.tgzOption 5: Git Submodule
# In your other project
git submodule add https://github.com/gregbanks/simple-comp.git
cd simple-comp
pnpm install
pnpm buildUsing the CLI
Once installed, you can use the CLI to add components:
# Initialize (first time only)
npx simple-comp init
# Add components
npx simple-comp add button card dialog
# List available components
npx simple-comp listDirect Import
If you've installed the entire package:
import { Button, Card } from '@gbdev20053/simple-comp-ui';
export function App() {
return (
<Card>
<Button>Click me</Button>
</Card>
);
}Component-by-Component Installation
The CLI approach is recommended as it only copies the components you need:
# This copies only the button component and its dependencies
npx simple-comp add buttonThen import from your local components:
import { Button } from '@/components/ui/button';Requirements
- React 18+ or React 19
- Tailwind CSS configured in your project
- TypeScript (recommended)
