search

Williams-RE / WRE-website

For home-buyers to see real estate listings nearby.
https://williamsrealestates.com
0 stars 0 forks source link

docs: update README #24

Closed timeowilliams closed 2 months ago

timeowilliams commented 2 months ago

Description

Related NOTION/Linear/JIRA tickets

Type of change

Testing

Screenshots/Screen Recordings :

Notes

Summary by CodeRabbit

railway-app[bot] commented 2 months ago
🚅 Deployed to the WRE-website-pr-24 environment in WRE Frontend Service Status Web Updated (UTC)
WRE-website ◻️ Removed (View Logs) Web Aug 25, 2024 at 2:10 am
coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@timeowilliams has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 31 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 9f36c453d13081db8dcfe3ba14f5539e54a632dd and 7b573f1687f349fd380693ef995f0268e42e43f4.

Walkthrough

Recent changes have been made to the README.md and playwright.config.js files. The README.md file has updated its badge images to enhance the visibility of test coverage metrics. In playwright.config.js, specific launch options have been removed to simplify the configuration for headless testing while keeping the overall timeout setting unchanged.

Changes

File Change Summary
README.md Modified badge images: removed "check source code," added "test coverage," retained "issues," "last commit," and "package size."
playwright.config.js Removed launchOptions and ignoreHTTPSErrors; overall timeout setting remains unchanged.

Poem

In the garden where code does sprout,
Badges shine, no room for doubt.
Testing's bright, a cover so neat,
Hops of joy, our work's complete!
Let's celebrate, with a cheer and a bound,
For every change makes progress profound! 🐰✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 2 months ago

📊 Package size report   -0%↓

File Before After
playwright.config.js 576 B -16%↓484 B
README.md 867 B -8.42%↓794 B
Total (Includes all files) 4.4 MB -0%↓4.4 MB
Tarball size 4.3 MB -0%↓4.3 MB
Unchanged files | File | Size | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------: | | [`.github/pull_request_template.md`](https://github.com/Williams-RE/WRE-website/blob/update-README/.github/pull_request_template.md) | `688 B` | | [`.github/workflows/check_source_code.yml`](https://github.com/Williams-RE/WRE-website/blob/update-README/.github/workflows/check_source_code.yml) | `353 B` | | [`.github/workflows/package_size.yml`](https://github.com/Williams-RE/WRE-website/blob/update-README/.github/workflows/package_size.yml) | `504 B` | | [`.github/workflows/playwright_tests.yml`](https://github.com/Williams-RE/WRE-website/blob/update-README/.github/workflows/playwright_tests.yml) | `620 B` | | [`package.json`](https://github.com/Williams-RE/WRE-website/blob/update-README/package.json) | `1.4 kB` | | [`public/ics.ics`](https://github.com/Williams-RE/WRE-website/blob/update-README/public/ics.ics) | `1.4 kB` | | [`public/index.html`](https://github.com/Williams-RE/WRE-website/blob/update-README/public/index.html) | `490 B` | | `public/W icon.ico` | `13.6 kB` | | `public/W logo.svg` | `1.1 kB` | | [`src/App.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/App.css) | `2.8 kB` | | [`src/App.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/App.js) | `3.5 kB` | | [`src/assets/background-large.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/background-large.avif) | `280.9 kB` | | [`src/assets/background-small.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/background-small.avif) | `247.7 kB` | | [`src/assets/buy-a-home/finding-the-deal.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/finding-the-deal.avif) | `37.9 kB` | | [`src/assets/buy-a-home/illustrations/illustration1.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/illustrations/illustration1.avif) | `142.4 kB` | | [`src/assets/buy-a-home/illustrations/illustration2.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/illustrations/illustration2.avif) | `144.2 kB` | | [`src/assets/buy-a-home/illustrations/illustration3.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/illustrations/illustration3.avif) | `127.4 kB` | | [`src/assets/buy-a-home/illustrations/update1-03.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/illustrations/update1-03.avif) | `173.8 kB` | | [`src/assets/buy-a-home/illustrations/update2-02.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/illustrations/update2-02.avif) | `155.0 kB` | | [`src/assets/buy-a-home/illustrations/update3-03.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/illustrations/update3-03.avif) | `108.9 kB` | | [`src/assets/buy-a-home/sealing-the-deal.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/buy-a-home/sealing-the-deal.avif) | `104.3 kB` | | [`src/assets/close-modal.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/close-modal.avif) | `2.7 kB` | | [`src/assets/icon_pencil.svg`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/icon_pencil.svg) | `367 B` | | [`src/assets/scale.webp`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/scale.webp) | `356.7 kB` | | [`src/assets/sell-a-home/before-you-start.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/before-you-start.avif) | `296.8 kB` | | [`src/assets/sell-a-home/finding-the-deal.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/finding-the-deal.avif) | `781.5 kB` | | [`src/assets/sell-a-home/illustrations/illustration4.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/illustrations/illustration4.avif) | `94.2 kB` | | [`src/assets/sell-a-home/illustrations/illustration5.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/illustrations/illustration5.avif) | `126.0 kB` | | [`src/assets/sell-a-home/illustrations/illustration6.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/illustrations/illustration6.avif) | `82.0 kB` | | [`src/assets/sell-a-home/illustrations/update5-05.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/illustrations/update5-05.avif) | `121.4 kB` | | [`src/assets/sell-a-home/sealing-the-deal.avif`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/sell-a-home/sealing-the-deal.avif) | `944.8 kB` | | [`src/assets/wre-logo.png`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/assets/wre-logo.png) | `7.4 kB` | | [`src/components/AboutUs.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/AboutUs.css) | `2.5 kB` | | [`src/components/AboutUs.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/AboutUs.jsx) | `4.4 kB` | | [`src/components/AddListing.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/AddListing.jsx) | `8.6 kB` | | [`src/components/AgentProfile.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/AgentProfile.css) | `683 B` | | [`src/components/AgentProfile.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/AgentProfile.jsx) | `1.2 kB` | | [`src/components/BuyAHome.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/BuyAHome.css) | `6.9 kB` | | [`src/components/BuyAHome.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/BuyAHome.jsx) | `7.0 kB` | | [`src/components/BuyerBrokerTable.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/BuyerBrokerTable.css) | `1.6 kB` | | [`src/components/BuyerBrokerTable.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/BuyerBrokerTable.jsx) | `8.1 kB` | | [`src/components/LandingPage.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/LandingPage.css) | `717 B` | | [`src/components/LandingPage.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/LandingPage.jsx) | `1.3 kB` | | [`src/components/Listing.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/Listing.css) | `576 B` | | [`src/components/Listing.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/Listing.jsx) | `829 B` | | [`src/components/ListingsLayout.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/ListingsLayout.css) | `78 B` | | [`src/components/ListingsLayout.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/ListingsLayout.jsx) | `859 B` | | [`src/components/ListingsManager.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/ListingsManager.jsx) | `641 B` | | [`src/components/Login.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/Login.css) | `1.2 kB` | | [`src/components/Login.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/Login.jsx) | `2.2 kB` | | [`src/components/ModalButton.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/ModalButton.css) | `2.9 kB` | | [`src/components/ModalButton.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/ModalButton.jsx) | `6.3 kB` | | [`src/components/NavBar.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/NavBar.css) | `2.0 kB` | | [`src/components/NavBar.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/NavBar.jsx) | `2.3 kB` | | [`src/components/SellAHome.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/SellAHome.css) | `4.5 kB` | | [`src/components/SellAHome.jsx`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/components/SellAHome.jsx) | `4.9 kB` | | [`src/contexts/AgentContext.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/contexts/AgentContext.js) | `829 B` | | [`src/index.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/index.css) | `366 B` | | [`src/index.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/index.js) | `231 B` | | [`src/lib/react-multi-carousel.css`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/lib/react-multi-carousel.css) | `3.0 kB` | | [`src/lib/utils.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/src/lib/utils.js) | `2.3 kB` | | [`tests/e2e/contact.spec.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/tests/e2e/contact.spec.js) | `1.4 kB` | | [`tests/e2e/listings.spec.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/tests/e2e/listings.spec.js) | `2.9 kB` | | [`tests/e2e/navigation.spec.js`](https://github.com/Williams-RE/WRE-website/blob/update-README/tests/e2e/navigation.spec.js) | `1.7 kB` |

🤖 This report was automatically generated by pkg-size-action