@cfpb/design-system-react 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Gabriel Pereira Woitechen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# CFPB Design System React
+
+A React/Storybook implementation of [CFPB's Design System](https://github.com/cfpb/design-system).
+
+## Status
+
+✨ Pre-release. Interfaces will change. Things will break.
+
+Current components: https://cfpb.github.io/design-system-react
+
+## Installation
+
+Until we start publishing to npm, install this github repo:
+
+```
+yarn add cfpb/design-system-react
+```
+
+If you're using yarn v2 or greater, [`yarn pack`](https://yarnpkg.com/advanced/lifecycle-scripts) will automatically build the package for you after it's installed.
+
+## Usage
+
+```ts
+import { Button, Alert } from 'design-system-react';
+import type { ReactElement } from 'react';
+
+export default function SomePage(): ReactElement {
+  return (
+    <main>
+      <Alert message='2025-Q1 Quarterly filing period is open' type='success'>
+        Submissions of 2025-Q1 SBL data will be accepted through May 2025.
+      </Alert>
+      <Button onClick={async () => login()} label='Log in' />
+      <Button
+        onClick={async () => register()}
+        appearance='secondary'
+        label='Register'
+      />
+    </main>
+  );
+}
+```
+
+## Development
+
+To edit components or add new ones, make sure you have Yarn v3 set up locally and then run `yarn dev`:
+
+1. Install Node v20+.
+1. Enable [corepack](https://yarnpkg.com/getting-started/install): `corepack enable`.
+1. `yarn`
+1. `yarn start`
+
+Note: This project uses yarn v3.5 in "plug n play" mode. There is no `node_modules/` directory. Packages are stored in `.yarn/cache/`.
+
+Edit the files in `src/components/` and your browser should hot reload your changes.
+
+Add tests to files called `<component-name>.test.tsx`. See [`Buttons.test.tsx`](/src/components/Button.test.tsx) for an example.
+
+Run `yarn test` to watch for changes and run tests automatically.
+
+[Netlify](https://www.netlify.com/) will build and deploy a preview of any pull requests you open.
+
+## Integrating changes to the CFPB Design System
+
+After modifications made to the Design System have been released in the [NPM package](https://www.npmjs.com/package/@cfpb/cfpb-design-system), we can integrate those changes by updating our dependencies.
+
+1. Create a PR in DSR that updates the Design System library versions
+
+```
+git checkout main
+git pull --rebase
+git checkout -b update-cfpb-ds
+yarn up @cfpb/cfpb-design-system
+yarn up @cfpb/cfpb-expandables
+yarn up @cfpb/cfpb-forms
+git add --all
+git commit -m 'chore: Update CFPB DS to <new.version.number>'
+git push
+```
+
+2. Review & merge the PR
+3. Upon merge, updates will be auto-deployed to [cfpb.github.io/design-system-react/](https://cfpb.github.io/design-system-react/)
+
+## Open source licensing info
+
+1. [TERMS](TERMS.md)
+2. [LICENSE](LICENSE)
+3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)