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.

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

feat: Remove example app #2162

Merged
merged 5 commits into from
Jun 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 1 addition & 32 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,35 +41,4 @@ updates:
- dependency-name: 'uswds'
- dependency-name: 'husky'
versions:
- '>=5.0.0'

- package-ecosystem: npm
directory: '/example/'
schedule:
interval: weekly
pull-request-branch-name:
separator: '-'
open-pull-requests-limit: 10
reviewers:
- "suzubara"
- "haworku"
- "ahobson"
labels:
- 'type: dependencies'
- 'type: automerge'
- 'type: example'
allow:
- dependency-type: all
ignore:
- dependency-name: react
versions:
- '>=18.0.0'
- dependency-name: react-dom
versions:
- '>=18.0.0'
- dependency-name: '@types/react'
versions:
- '>=18.0.0'
- dependency-name: '@types/react-dom'
versions:
- '>=18.0.0'
- '>=5.0.0'
1 change: 0 additions & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@

# Owners for PRs that change ONLY package.json and/or yarn.lock
# Note: Reviewers for dependabot PRs that change these files are configured in .github/dependabot.yml under `reviewers`
# for both the main repository and the example app.
package.json
yarn.lock
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ This is a frontend component library, built in [React](https://reactjs.org/) wit

A deployed instance of the ReactUSWDS Storybook is located at: [https://trussworks.github.io/react-uswds/](https://trussworks.github.io/react-uswds/)

An example application, built with React-USWDS, can be found in the `/example` folder and run with the appropriate [`yarn:example` commands](./docs/contributing.md#available-commands).

**Table of Contents**

- [@trussworks/react-uswds](#trussworksreact-uswds)
Expand Down
32 changes: 16 additions & 16 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,21 @@ We welcome contributions in the form of comments, issues, or pull requests with

**Table of Contents**

- [Environment setup](#environment-setup)
- [Available commands](#available-commands)
- [Development](#development)
- [Working on an issue](#working-on-an-issue)
- [General guidelines](#general-guidelines)
- [Linting, formatting, & automated tests](#linting-formatting--automated-tests)
- [Testing in an application](#testing-in-an-application)
- [Opening & merging pull requests](#opening--merging-pull-requests)
- [Contributing](#contributing)
- [Environment setup](#environment-setup)
- [Available commands](#available-commands)
- [Development](#development)
- [Working on an issue](#working-on-an-issue)
- [General guidelines](#general-guidelines)
- [Linting, formatting, & automated tests](#linting-formatting--automated-tests)
- [Testing in an application](#testing-in-an-application)
- [`yarn link`](#yarn-link)
- [Install from a ReactUSWDS branch](#install-from-a-reactuswds-branch)
- [Opening & merging pull requests](#opening--merging-pull-requests)
- [`type`:](#type)
- [`scope`:](#scope)
- [`body`:](#body)
- [`footer`:](#footer)

## Environment setup

Expand All @@ -40,12 +47,6 @@ These should all be run from within the project directory.
- `yarn build`
- Builds files from `/src` and outputs to `/lib` using webpack and UMD library target
- `yarn build:watch` is also available
- `yarn example:install`
- Installs dependencies for the example app. This must be run prior to viewing/developing the example application (located in `/example`).
- Builds the library files from `/src` into `/lib`, and also runs `yarn install` in the `/example` directory
- `yarn example:start`
- After installing dependencies, use this to start the example app dev server, so you can view the example app and also add to it.

## Development

### Working on an issue
Expand All @@ -65,7 +66,7 @@ For example: `hw-accordion-component-112`
- Encourage a strict separation of concerns, focusing on UI (rendered HTML and CSS) rather than any application logic.
- Expose the necessary props for composability and extensibility, such as event handlers, custom CSS classes, etc.
- Maintain a high standard of unit test coverage and cross-browser/device support, so that projects including this dependency can focus on integration and implementation.
- Provide thorough documentation (in Storybook and in the example app) so that users can view the components as they render in the UI, the source code required to use them, and specifications such as how props are used, a11y support, and test coverage.
- Provide thorough documentation (in Storybook) so that users can view the components as they render in the UI, the source code required to use them, and specifications such as how props are used, a11y support, and test coverage.
- Consistent and transparent versioning so that multiple projects can rely on this package, and it can be maintained as React and USWDS release new versions while also providing backwards compatibility.

More guidance for preferred React practices can be found in the [adding new components](./adding_new_components.md) documentation.
Expand Down Expand Up @@ -246,7 +247,6 @@ Optional, can be one of the following:
- `deps-dev`: Updating a package listed in devDependencies
- `release`: Releasing a new version
- `circleci`: Changes to CircleCI config and/or scripts
- `example`: Changes to the Example App only
- `storybook`: Changes to Storybook or stories files only

#### `body`:
Expand Down
2 changes: 1 addition & 1 deletion docs/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- How do I use a component from this library?

- Most components are standalone and can be dropped into your codebase anywhere. Assuming that you have imported the library and styles properly, please reference the project [Storybook](https://trussworks.github.io/react-uswds/) to learn how to use the component in your code. Click any of the component stories and you can "Show Code" to see the usage of the component in context. Storybook also has a tab on each story called "Docs" which will allow you to see full documentation of the types of props you can use. In addition, we have an example app (see `/example` directory) which shows how to use `react-uswds` components with other widely used Javascript/React dependencies.
- Most components are standalone and can be dropped into your codebase anywhere. Assuming that you have imported the library and styles properly, please reference the project [Storybook](https://trussworks.github.io/react-uswds/) to learn how to use the component in your code. Click any of the component stories and you can "Show Code" to see the usage of the component in context. Storybook also has a tab on each story called "Docs" which will allow you to see full documentation of the types of props you can use.

- If something is not behaving as it should, or if I believe I've spotted a problem, where should I open an issue?

Expand Down
23 changes: 0 additions & 23 deletions example/.gitignore

This file was deleted.

54 changes: 0 additions & 54 deletions example/README.md

This file was deleted.

10 changes: 0 additions & 10 deletions example/config-overrides.js

This file was deleted.

53 changes: 0 additions & 53 deletions example/package.json

This file was deleted.

Binary file removed example/public/favicon.ico
Binary file not shown.
43 changes: 0 additions & 43 deletions example/public/index.html

This file was deleted.

Binary file removed example/public/logo192.png
Binary file not shown.
Binary file removed example/public/logo512.png
Binary file not shown.
25 changes: 0 additions & 25 deletions example/public/manifest.json

This file was deleted.

3 changes: 0 additions & 3 deletions example/public/robots.txt

This file was deleted.

Empty file removed example/src/App.css
Empty file.
9 changes: 0 additions & 9 deletions example/src/App.test.tsx

This file was deleted.

Loading