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

Sc 12333/ensign footer #120

Merged
merged 21 commits into from Jan 27, 2023
Merged

Sc 12333/ensign footer #120

merged 21 commits into from Jan 27, 2023

Conversation

daniellemaxwell
Copy link
Contributor

@daniellemaxwell daniellemaxwell commented Jan 26, 2023

Scope of changes

Adds Footer component to Beacon UI. Also, updates the React app setup by adding the following:

  • Favicons
  • Meta tags
  • robots.txt file
  • humans.txt file
  • Lingui
  • Sentry (The basic configuration from the Ensign landing page was used, but this will most likely need to be updated.)

Some additional clean up was done by deleting the ensign-user-ui, since beacon-app is replacing it.

Note: It was decided to not focus on mobile responsiveness before the MVP release. Responsive styling will be updated in the future so that the footer appears better on smaller screens.

Fixes SC-12333

Type of change

  • new feature
  • bug fix
  • documentation
  • testing
  • technical debt
  • other (describe)

Acceptance criteria

Screenshot 2023-01-27 at 2 49 25 PM (2)

Author checklist

  • I have manually tested the change and/or added automation in the form of unit tests or integration tests
  • I have updated the dependencies list
  • I have recompiled and included new protocol buffers to reflect changes I made
  • I have added new test fixtures as needed to support added tests
  • Check this box if a reviewer can merge this pull request after approval (leave it unchecked if you want to do it yourself)
  • I have moved the associated Shortcut story to "Ready for Review"

Reviewer(s) checklist

  • Any new user-facing content that has been added for this PR has been QA'ed to ensure correct grammar, spelling, and understandability.
  • Are there any TODOs in this PR that should be turned into stories?

@shortcut-integration
Copy link

This pull request has been linked to Shortcut Story #12333: Ensign Landing Footer component.

<li>
<a href="https://rotational.io/ensign">Ensign</a>
</li>
{/* <li>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This and the SDK links will be hidden until they are available. A follow up story will be created in Shortcut.

function Footer() {
return (
<footer className="bg-footer bg-cover bg-no-repeat">
<div className="pt-64 2xl:pt-80">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

As the screen width increases, content in the footer goes above the background image. 2xl:pt-80 is a small hack to prevent this from happening. While updating the website's footer, I'll look into a better way of handing this.

@@ -0,0 +1,26 @@
import * as Sentry from '@sentry/react';
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the current Sentry configuration for rotational.app. I wanted to make sure we didn't forget to add this, but this may need to be updated.

Copy link
Contributor

Choose a reason for hiding this comment

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

would you mind moving this to application/config instead ?

@@ -0,0 +1,13 @@
{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was added so that Lingui will work correctly.

<meta property="og:type" content="website">
<meta property="og:title" content="Ensign by Rotational Labs">
<meta property="og:description" content="Ensign by Rotational Labs">
<meta property="og:image" content="">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll create a follow up story to add images to the meta tags. Also, Twitter is listed separately because last I checked their site has stopped recognizing og tags.

@@ -1,6 +1,11 @@
{
"name": "beacon-app",
"version": "0.2.0",
"description": "User UI for Ensign.",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was in the setup for the ensign-user-ui, so this was added for consistency.

@daniellemaxwell daniellemaxwell marked this pull request as ready for review January 26, 2023 22:02
Copy link
Contributor

@masskoder masskoder left a comment

Choose a reason for hiding this comment

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

Kudos 👍 .
Few minor changes that need to be done,
Also, would you mind adding this component to the storybook?

@@ -0,0 +1,26 @@
import * as Sentry from '@sentry/react';
Copy link
Contributor

Choose a reason for hiding this comment

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

would you mind moving this to application/config instead ?

Comment on lines +5 to +9
const dsn = process.env.REACT_APP_SENTRY_DSN;
const environment = process.env.REACT_APP_SENTRY_ENVIRONMENT
? process.env.REACT_APP_SENTRY_ENVIRONMENT
: process.env.NODE_ENV;

Copy link
Contributor

Choose a reason for hiding this comment

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

we are going to avoid using process.env directly, what do you think if you define those environments in application/config/appConfig and consume them everywhere it's needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've made the update. I didn't see the config file before.

);
}

export default Footer;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
export default Footer;
export default React.memo(Footer);

Would you mind making this component a pure component?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I got an error with this change so, I imported memo and did the following export default memo(LandingFooter);. I also updated the file name to be a little more specific since this footer won't be used once a user registers or logs in.

Copy link
Contributor

@masskoder masskoder left a comment

Choose a reason for hiding this comment

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

LGTM

@daniellemaxwell daniellemaxwell merged commit 3b68cf4 into main Jan 27, 2023
@daniellemaxwell daniellemaxwell deleted the sc-12333/ensign-footer branch January 27, 2023 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants