Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BelkacemYerfa/shadcn-extension
An open source component collection , that extends your ui library , built using shadcn component
https://github.com/BelkacemYerfa/shadcn-extension
component nextjs radix-ui react shadcn-ui tailwindcss
Last synced: 23 days ago
JSON representation
An open source component collection , that extends your ui library , built using shadcn component
- Host: GitHub
- URL: https://github.com/BelkacemYerfa/shadcn-extension
- Owner: BelkacemYerfa
- License: mit
- Created: 2024-01-28T21:21:17.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-08-01T17:51:07.000Z (4 months ago)
- Last Synced: 2024-08-01T22:57:08.181Z (4 months ago)
- Topics: component, nextjs, radix-ui, react, shadcn-ui, tailwindcss
- Language: TypeScript
- Homepage: https://shadcn-extension.vercel.app/
- Size: 1.31 MB
- Stars: 544
- Watchers: 3
- Forks: 17
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-shadcn-ui - shadcn-extension - An open-source component collection that extends your UI library, built using shadcn/ui components. (Libs and Components)
- awesome-shadcn-ui - Shadcn Extension - An open source component collection , that extends your ui library , built using shadcn component (Components)
- awesome-shadcn-ui - Shadcn Extension - An open source component collection , that extends your ui library , built using shadcn component (Components)
README
# Shadcn Extension Turborepo
This is the official starter for the Shadcn Extension Turborepo, a monorepo setup for developing and sharing reusable UI components.
## What is Turborepo?
Turborepo is a high-performance build system for JavaScript and TypeScript codebases. It is designed for scaling monorepos and also makes workflows in single-package workspaces faster, too. Turborepo optimizes build and development processes by caching, parallel execution, and dependency graph analysis.
## About This Repository
This repository is a monorepo, which means it contains multiple projects managed in a single codebase. This approach simplifies dependency management and sharing code between projects.
### Tools and Technologies Used:
- **pnpm**: A fast, disk space-efficient package manager.
- **Turborepo**: A build system for monorepos.
- **TypeScript**: A statically typed superset of JavaScript.
- **Next.js**: A React framework for production.
## Structure
The repository is structured as follows:
```
shadcn-extension-turborepo/
├── apps/
│ └── extension/
│ ├── content/
│ │ └── docs/
│ ├── public/
│ │ ├── registry/
│ │ ├── next.svg
│ │ ├── og.png
│ │ └── vercel.svg
│ ├── src/
│ │ ├── __registry__/
│ │ ├── app/
│ │ ├── components/
│ │ ├── config/
│ │ ├── hooks/
│ │ ├── lib/
│ │ ├── registry/
│ │ ├── script/
│ │ ├── types/
│ │ └── env.ts
├── packages/
│ ├── CLI/
│ │ ├── src/
│ │ ├── __tests__/
│ │ ├── commands/
│ │ ├── utils/
│ │ └── index.ts
│ ├── eslint-config/
│ │ ├── library.js
│ │ ├── next.js
│ │ ├── package.json
│ │ ├── react-internal.js
│ │ └── README.md
│ └── typescript-config/
│ ├── base.json
│ ├── nextjs.json
│ ├── package.json
│ └── react-library.json
└── pnpm-workspace.yaml
```
## Getting Started
### Cloning the Repository
First, clone the monorepo to your local machine:
```sh
git clone https://github.com/BelkacemYerfa/shadcn-extension.git
cd shadcn-extension
```
### Installation
Install all dependencies using `pnpm`:
```sh
pnpm install
```
### Building the Project
To build all apps and packages, run the following command:
```sh
pnpm build
```
This will compile the TypeScript code and prepare the project for development and production.
### Development
To start the development server for all apps and packages, run:
```sh
pnpm dev
```
This command will run the development servers and watch for changes, enabling live reload for a smoother development experience.
## CLI
The `@shadx/cli` package is a command-line interface (CLI) for adding components to your project. It helps automate repetitive tasks, such as creating new components or setting up configurations.
You can find detailed instructions for using the CLI in the [CLI README](/packages/cli/README.md).
## Additional Resources
- [pnpm Documentation](https://pnpm.io)
- [Turborepo Documentation](https://turbo.build/repo)
- [Next.js Documentation](https://nextjs.org/docs)
- [TypeScript Documentation](https://www.typescriptlang.org/docs/)
## Contributing
Contributions are welcome! Please open an issue or submit a pull request with your changes. Make sure to follow the project's code of conduct and guidelines for contributing.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/BelkacemYerfa/shadcn-extension/blob/master/LICENSE.md) file for details.