Skip to content

Commit

Permalink
Merge pull request #43 from reactioncommerce/renaming
Browse files Browse the repository at this point in the history
Renaming. Everything.
  • Loading branch information
machikoyasuda authored Aug 1, 2019
2 parents 81e5845 + 54b93ab commit 866643a
Show file tree
Hide file tree
Showing 19 changed files with 77 additions and 66 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@ styleguide/favicon.png
styleguide/fonts/
styleguide/index.html
styleguide/manifest.json
styleguide/reaction-design-system-logo.svg
styleguide/catalyst-logo.svg

.DS_Store
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
# Reaction Catalyst Component Library
# Catalyst

[![npm (scoped)](https://img.shields.io/npm/v/@reactioncommerce/catalyst.svg)](https://www.npmjs.com/package/@reactioncommerce/catalyst)
[![CircleCI](https://circleci.com/gh/reactioncommerce/catalyst.svg?style=svg)](https://circleci.com/gh/reactioncommerce/catalyst)

![Reaction Design System](https://blog.reactioncommerce.com/content/images/2018/09/style-guide-artwork.jpg)

> ⚠️ Warning: This repository is in active development and is not ready for testing or usage.
This is a single project with a package of commerce-focused React UI components and the code for the Reaction Design System website:
This is a single project with a package of commerce-focused React UI components and the code for the Catalyst website:

- [`@reactioncommerce/catalyst`](https://www.npmjs.com/package/@reactioncommerce/catalyst): See the [package.json](https://github.com/reactioncommerce/catalyst/blob/master/package/package.json) in [`/package`](https://github.com/reactioncommerce/catalyst/tree/master/package) folder.
- [Catalyst Components](https://catalyst.reactioncommerce.com/): See the root [package.json](https://github.com/reactioncommerce/catalyst/blob/master/package.json).

We use the [React Styleguidist](https://react-styleguidist.js.org/) package to run and build the Reaction Design System website, and running the style guide locally doubles as an interactive playground for developing and testing the components.
We use the [React Styleguidist](https://react-styleguidist.js.org/) package to run and build the Catalyst website, and running the style guide locally doubles as an interactive playground for developing and testing the components.

## Use the React components in your project
## Use the React components in your Reaction Admin plugin

Refer to the [Reaction Catalyst Components doc](https://catalyst.reactioncommerce.com/#/Introduction/Using%20Components)

Expand All @@ -24,7 +22,7 @@ Refer to the [contributor docs](./docs)

## License

Copyright 2018 Reaction Commerce
Copyright 2019 Reaction Commerce

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Reaction Design System and Component Library - Contributor Docs
# Catayst - Contributor Docs

## Getting Started

Expand Down
2 changes: 1 addition & 1 deletion docs/developing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Running and Developing Locally

These instructions are the same regardless of whether you're developing components within the Reaction Design System or developing the Reaction Design System website itself.
These instructions are the same regardless of whether you're developing components within Catalyst or developing the Catalyst website itself.

## Run for Development

Expand Down
2 changes: 1 addition & 1 deletion docs/repo-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ There are two package.json files.

If you're working on the Style Guide exclusively, you'll mostly edit `styleguide.config.js` and the files in the `styleguide` folder.

If you're creating or modifying component library components, you'll mostly edit files in the `package` folder, but you'll also need to add new components to `styleguide.config.js` to get them to appear in the Style Guide. You might also need to add or modify section markdown in the `styleguide` folder.
If you're creating or modifying Catalyst components, you'll mostly edit files in the `package` folder, but you'll also need to add new components to `styleguide.config.js` to get them to appear in the Style Guide. You might also need to add or modify section markdown in the `styleguide` folder.
4 changes: 2 additions & 2 deletions docs/reviewing-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
A Pull Request for a component will be reviewed by three groups:
1. **Development** - Developer checks for code style, code tests and component functionality
1. **Design** - Designer checks for design specs of the component itself.
1. **Documentation** - Documentation checks for how the component and documentation render on the Component Library site.
1. **Documentation** - Documentation checks for how the component and documentation render on the Catalyst site.

Reviewers should be able to view the component live in a Netlify deployed branch.

After the component is approved, the NPM module will be released with semantic release.

Once the component is published, developers can use the new component in any project, like the [Reaction Example Storefront](https://github.com/reactioncommerce/example-storefront). Designers will then review the component again, to check that the component has been implemented to proper design usage guidelines.
Once the component is published, developers can use the new component in Reaction Admin. Designers will then review the component again, to check that the component has been implemented to proper design usage guidelines.

2 changes: 1 addition & 1 deletion package/src/components/ConfirmDialog/ConfirmDialog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Overview

The `ConfirmDialog` component uses [Dialog](https://material-ui.com/api/dialog), [DialogActions](https://material-ui.com/api/dialog-actions/), [DialogContent](https://material-ui.com/api/dialog-content/), [DialogContentText](https://material-ui.com/api/dialog-content-text/), [Button](https://material-ui.com/api/button/) from Material-UI and [DialogTitle](http://localhost:4060/#/Base%20Components/Feedback/DialogTitle) from Catalyst.
The `ConfirmDialog` component uses [Dialog](https://material-ui.com/api/dialog), [DialogActions](https://material-ui.com/api/dialog-actions/), [DialogContent](https://material-ui.com/api/dialog-content/), [DialogContentText](https://material-ui.com/api/dialog-content-text/), [Button](https://material-ui.com/api/button/) from Material-UI and [DialogTitle](/#/Components/Feedback/DialogTitle) from Catalyst.

### Usage

Expand Down
2 changes: 1 addition & 1 deletion package/src/theme/colors.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Default Reaction Design System Colors
* Default Catalyst Colors
*/

export default {
Expand Down
40 changes: 22 additions & 18 deletions styleguide.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function generateSection({ componentNames, name, content }) {
}

module.exports = {
title: "Reaction Design System",
title: "Catalyst Design System | Reaction Commerce",
theme: {
sidebarWidth: 320,
maxWidth: 1000,
Expand Down Expand Up @@ -118,7 +118,7 @@ module.exports = {
},
logo: {
borderBottom: [[0]],
backgroundImage: "url(reaction-design-system-logo.svg)",
backgroundImage: "url(catalyst-logo.svg)",
backgroundRepeat: "no-repeat",
height: 110,
backgroundPosition: "25% 50%",
Expand Down Expand Up @@ -301,26 +301,18 @@ module.exports = {
content: "styleguide/src/sections/Introduction.md",
sections: [
{
name: "Using Components",
content: "styleguide/src/sections/InstallingandImporting.md"
},
{
name: "Theming Components",
content: "styleguide/src/sections/ThemingComponents.md"
name: "Installation",
content: "styleguide/src/sections/Installation.md"
},
{
name: "Understanding Component References",
content: "styleguide/src/sections/ComponentsContext.md"
},
{
name: "Developing Locally Inside Another Project",
content: "styleguide/src/sections/LocalDevelopment.md"
}
],
sectionDepth: 2
},
{
name: "Style",
name: "Designers",
sections: [
{
name: "Colors",
Expand All @@ -334,13 +326,26 @@ module.exports = {
sectionDepth: 2
},
{
name: "Base Components",
name: "Developers",
sections: [
{
name: "Theming",
content: "styleguide/src/sections/Theming.md"
},
{
name: "Developing Locally Inside Another Project",
content: "styleguide/src/sections/LocalDevelopment.md"
}
],
sectionDepth: 2
},
{
name: "Components",
sections: [
generateSection({
componentNames: [
"Button"
],
content: "styleguide/src/sections/Actions.md",
name: "Actions"
}),
generateSection({
Expand All @@ -355,7 +360,6 @@ module.exports = {
"ConfirmDialog",
"DialogTitle"
],
content: "styleguide/src/sections/Feedback.md",
name: "Feedback"
})
],
Expand Down Expand Up @@ -391,8 +395,8 @@ module.exports = {
return `import ${name} from "@reactioncommerce/catalyst/${name}"`;
},
pagePerSection: true,
showCode: true,
showUsage: true,
exampleMode: "expand",
usageMode: "expand",
serverPort: Number(process.env.PORT || 6060),
assetsDir: "styleguide/src/assets/",
styleguideDir: "styleguide/dist",
Expand Down
20 changes: 20 additions & 0 deletions styleguide/src/assets/catalyst-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 866643a

Please sign in to comment.