Skip to content

Commit

Permalink
Fix broken app, add back missing files
Browse files Browse the repository at this point in the history
  • Loading branch information
zeekay committed Apr 22, 2024
1 parent 7514d07 commit cbf3f24
Show file tree
Hide file tree
Showing 1,112 changed files with 36,189 additions and 2,254 deletions.
46 changes: 17 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing

Thanks for your interest in contributing to ui.shadcn.com. We're happy to have you here.
Thanks for your interest in contributing to ui.hanzo.ai. We're happy to have you here.

Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.

If you need any help, feel free to reach out to [@shadcn](https://twitter.com/shadcn).
If you need any help, feel free to reach out to [@hanzoai](https://twitter.com/hanzoai).

## About this repository

Expand All @@ -20,7 +20,7 @@ This repository is structured as follows:

```
apps
└── www
└── web
├── app
├── components
├── content
Expand All @@ -37,11 +37,11 @@ packages

| Path | Description |
| --------------------- | ---------------------------------------- |
| `apps/www/app` | The Next.js application for the website. |
| `apps/www/components` | The React components for the website. |
| `apps/www/content` | The content for the website. |
| `apps/www/registry` | The registry for the components. |
| `packages/cli` | The `shadcn-ui` package. |
| `apps/web/app` | The Next.js application for the website. |
| `apps/web/components` | The React components for the website. |
| `apps/web/content` | The content for the website. |
| `apps/web/registry` | The registry for the components. |
| `packages/ui` | The `@hanzo/ui` package. |

## Development

Expand Down Expand Up @@ -79,35 +79,29 @@ You can use the `pnpm --filter=[WORKSPACE]` command to start the development pro

#### Examples

1. To run the `ui.shadcn.com` website:
1. To run the `ui.hanzo.ai` website:

```bash
pnpm --filter=www dev
```

2. To run the `shadcn-ui` package:

```bash
pnpm --filter=shadcn-ui dev
pnpm --filter=web dev
```

## Documentation

The documentation for this project is located in the `www` workspace. You can run the documentation locally by running the following command:
The documentation for this project is located in the `web` workspace. You can run the documentation locally by running the following command:

```bash
pnpm --filter=www dev
pnpm --filter=web dev
```

Documentation is written using [MDX](https://mdxjs.com). You can find the documentation files in the `apps/www/content/docs` directory.
Documentation is written using [MDX](https://mdxjs.com). You can find the documentation files in the `apps/web/content/docs` directory.

## Components

We use a registry system for developing components. You can find the source code for the components under `apps/www/registry`. The components are organized by styles.
We use a registry system for developing components. You can find the source code for the components under `apps/web/registry`. The components are organized by styles.

```bash
apps
└── www
└── web
└── registry
├── default
│ ├── example
Expand Down Expand Up @@ -138,7 +132,7 @@ the following categories:
issue if present)
- `refactor`: any code related change that is not a fix nor a feature
- `docs`: changing existing or creating new documentation (i.e. README, docs for
usage of a lib or cli usage)
usage of a lib)
- `build`: all changes regarding the build of the software, changes to
dependencies or the addition of new dependencies
- `test`: all changes regarding tests (adding new tests or changing existing
Expand All @@ -151,19 +145,13 @@ the following categories:
e.g. `feat(components): add new prop to the avatar component`

If you are interested in the detailed specification you can visit
https://www.conventionalcommits.org/ or check out the
https://web.conventionalcommits.org/ or check out the
[Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).

## Requests for new components

If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.

## CLI

The `shadcn-ui` package is a CLI for adding components to your project. You can find the documentation for the CLI [here](https://ui.shadcn.com/docs/cli).

Any changes to the CLI should be made in the `packages/cli` directory. If you can, it would be great if you could add tests for your changes.

## Testing

Tests are written using [Vitest](https://vitest.dev). You can run all the tests from the root of the repository.
Expand Down
16 changes: 0 additions & 16 deletions apps/ui-demo/public/registry/styles/default/carousel.json

This file was deleted.

13 changes: 0 additions & 13 deletions apps/ui-demo/public/registry/styles/default/pagination.json

This file was deleted.

Loading

0 comments on commit cbf3f24

Please sign in to comment.