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

docs(example-app): Example app UI #202 #237

Merged
merged 3 commits into from
Jun 15, 2020
Merged

Conversation

suzubara
Copy link
Contributor

@suzubara suzubara commented Jun 5, 2020

Summary

Bootstraps basic UI for the example application, including routing with React Router.

Related Issues or PRs

Closes #202

How To Test

Navigate to the /example directory, install dependencies (yarn install), and start the app (yarn start). Verify you can view the app, which currently just has two pages that are mostly empty (home & examples).

Screenshots (optional)

image

@suzubara suzubara added the type: example Example implementations of ReactUSWDS, such as Storybook or kitchen sink app label Jun 5, 2020
@suzubara
Copy link
Contributor Author

suzubara commented Jun 5, 2020

note: I ended up using react-router instead of hookrouter because I ran into some basic bugs with hookrouter and decided it would be better to use a more common library. I still don't love react-router but it feels like the lesser evil.

@trussworks-infra-zz
Copy link

trussworks-infra-zz commented Jun 5, 2020

Warnings
⚠️

Changes were made to package.json, but not to yarn.lock - Perhaps you need to run yarn install?

⚠️ This PR does not include changes to storybook, even though it affects component code.
⚠️ This PR does not include changes to tests, even though it affects source code.

Generated by 🚫 dangerJS against 8bffe2f

@haworku
Copy link
Contributor

haworku commented Jun 9, 2020

Suggestion: edit dangerfile to ignore changes in /example for storybook and tests warnings.

Copy link
Contributor

@eamahanna eamahanna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@suzubara Do you want to add documentation stating that you have to run yarn build for the entire library before attempting yarn start for the example app?

@haworku
Copy link
Contributor

haworku commented Jun 12, 2020

Another option: could we have a script to run example app that does yarn build and then starts up app from example folder?

@haworku haworku assigned suzubara and unassigned suzubara Jun 15, 2020
@suzubara suzubara merged commit 832decc into develop Jun 15, 2020
@suzubara suzubara deleted the sr-example-app-ui-202 branch June 15, 2020 18:00
haworku added a commit that referenced this pull request Jun 15, 2020
commit 1054469
Author: Emily Mahanna <56279459+eamahanna@users.noreply.github.com>
Date:   Mon Jun 15 10:40:45 2020 -0800

    feat(example app): add modals page example 204 (#250)

    * WIP Set up basic layout, router

    * Switch to react-router, add placeholder content

    * feat(example app): add modals example page

    * feat(example app): add redux for modals

    * hook up modals page

    * feat(example app): add hook modal

    * fix(modals page): fixes from PR review

    * fix(modals page): pr update

    * fix(modals page): remove comment

    * fix(modals page): add import back in

    Co-authored-by: Suzanne Rozier <suz@truss.works>

commit 832decc
Author: Suzanne Rozier <suz@truss.works>
Date:   Mon Jun 15 13:00:03 2020 -0500

    docs(example-app): Example app UI #202 (#237)

    * WIP Set up basic layout, router

    * Switch to react-router, add placeholder content

    * Add docs and commands for running the example app
@haworku haworku mentioned this pull request Jun 29, 2020
haworku pushed a commit that referenced this pull request Jun 29, 2020
* WIP Set up basic layout, router

* Switch to react-router, add placeholder content

* Add docs and commands for running the example app
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: example Example implementations of ReactUSWDS, such as Storybook or kitchen sink app
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feat] Bootstrap example application UI
4 participants