Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs/readme 20240422 #39

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Docs/readme 20240422 #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c0b425
docs: update readme
dannytlake Apr 22, 2024
cfc4075
docs: update readme
dannytlake Apr 22, 2024
f08e392
docs: update installation docs
dannytlake Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/docs/design/components_and_theme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@ These pre-built components and design resources help you to save time and effort

Composable UI provides React components and layouts that you can use to build your e-commerce solution.

The `@composable/ui` package, which is in the `packages/ui` directory, contains standard re-usable components, such as accordions, alert boxes, carousels, gallery, and product cards. The components in the `composable-ui` directory leverages the components in the `packages/ui` directory to build more complex components, such as the cart page, menu, Product Listing Pages (PLP), and Product Display Pages (PDP).
Located in the `packages/ui` directory, the `@composable/ui` workspace package contains standard re-usable UI components, such as accordions, alert boxes, carousels, gallery, and product cards. The Next.js storefront application in directory `composable-ui` uses the basic UI components from `@composable/ui` to construct user experiences and components, such as the Cart Drawer, Mobile Menu, Product Listing Pages (PLP), Product Display Pages (PDP), and Checkout.

The `packages/ui` directory is exported as `@composable/ui` and you can import it in the code as required. The `@composable/ui` package contains the UI components and you can share these components between both Next.js Composable UI application and the Storybook application.

Composable UI uses [Chakra UI](https://chakra-ui.com) as the base component library and as the building block for additional components. Using Chakra UI in your commerce solution enables you to take advantage of a React-based system with accessibility features, customizability, and a large community of developers.
Composable UI uses [Chakra UI](https://chakra-ui.com) to construct all the components and experiences on the Composable UI Storefront. Using Chakra UI enables us to take advantage of a large React UI component library that provides excellent support for accessibility, customization, and support from large community of developers.

## Using a component

Expand Down
4 changes: 3 additions & 1 deletion docs/docs/getting_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,10 @@ Ensure that you have installed the following on the local development machine:
### Installation Steps

1. Clone the [source repository](https://github.com/composable-com/composable-ui) to your local development environment.

`git clone https://github.com/composable-com/composable-ui`
2. Follow the instructions in the [README](https://github.com/composable-com/composable-ui#readme) for local setup and configuration.
3. Optionally, follow the instructions in the [README](https://github.com/composable-com/composable-ui#readme) to deploy Composable UI to a hosting provider.
3. Optionally, follow the instructions on [docs.composable.com](https://docs.composable.com/docs/build_and_deploy/deploy#deploy-composable-ui) to deploy Composable UI to a hosting provider.

Be sure to read the documentation on Composable UI's [environment variables](/docs/essentials/configuration)

Expand Down
Loading