docs: implement privacy policy and terms page

[Sanchitbajaj02]

Related Issue

reference issue: #147

Description

This issue fixes:

• some portions of footer fix
• implementation of navbar on some pages
• new routes: /privacy and /terms
• contact page is now group in support
• implement the github stars api as a seperate helper function

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
palettegram	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 20, 2024 7:17am

[coderabbitai]

Warning

Rate Limit Exceeded

@Sanchitbajaj02 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 48 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 for further information.

Commits

Files that changed from the base of the PR and between ce46833 and 00ba332.

Walkthrough

The updates encompass significant additions to Palettegram, a design and development-focused social media app. These changes include the implementation of a Privacy Policy page and a Terms of Use Agreement page. These additions enhance user information handling, provide clarity on app policies, and improve UI components like the navbar. Additionally, there are refinements in code organization, style adjustments, and minor logic enhancements in authentication and user registration processes.

Changes

File(s)	Change Summary
.../privacy/layout.tsx, .../terms/layout.tsx	Introduced SEO metadata in Privacy Policy and Terms of Use pages.
.../privacy/page.tsx, .../terms/page.tsx	Added new pages detailing Privacy Policy and Terms of Use with data handling and user agreement information.
src/app/[others]/page.tsx, src/app/page.tsx	Enhanced modularity and layout in the app's structure for better alignment and organization.
src/backend/auth.api.ts, src/backend/avatarGenerator.ts	Updated import syntax and made minor logic adjustments in authentication and avatar generation for readability and consistency.
src/components/core/footer/index.tsx, src/components/core/navbar/...	Updated Footer and Navbar components with dynamic content rendering for an interactive user experience.
src/components/core/supportHeader/index.tsx, .../auth/register/..., .../pages/user/index.tsx	Introduced SupportHeader component, adjusted registration flow, and reformatted user page for clarity and usability improvements.
src/helper/getGithubStars.ts, src/helper/toastify.ts	Implemented function for fetching GitHub stars and updated string literal usage in toast notifications for consistency.
src/styles/globals.css, src/types/index.d.ts	Added global styles for a cohesive look and refined type definitions for cleaner code.

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
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

Great job, @Sanchitbajaj02! 🎉 Thank you for submitting your pull request. Your contribution is valuable and we appreciate your efforts to improve our project. Keep being the part of the community!

'We will promptly review your changes and offer feedback. Keep up the excellent work!
Kindly remember to check our Contributing Guidelines'

[coderabbitai]

Review Status

Actionable comments generated: 11

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between aa374c2 and 69dff7c.

Files selected for processing (17)

• src/app/(support)/privacy/layout.tsx (1 hunks)
• src/app/(support)/privacy/page.tsx (1 hunks)
• src/app/(support)/terms/layout.tsx (1 hunks)
• src/app/(support)/terms/page.tsx (1 hunks)
• src/app/[others]/page.tsx (1 hunks)
• src/app/page.tsx (1 hunks)
• src/backend/auth.api.ts (3 hunks)
• src/backend/avatarGenerator.ts (1 hunks)
• src/components/core/footer/index.tsx (2 hunks)
• src/components/core/navbar/index.tsx (2 hunks)
• src/components/core/supportHeader/index.tsx (1 hunks)
• src/components/pages/auth/register/index.tsx (1 hunks)
• src/components/pages/user/index.tsx (1 hunks)
• src/helper/getGithubStars.ts (1 hunks)
• src/helper/toastify.ts (2 hunks)
• src/styles/globals.css (3 hunks)
• src/types/index.d.ts (1 hunks)

Files skipped from review due to trivial changes (6)

• src/app/(support)/privacy/layout.tsx
• src/app/(support)/terms/layout.tsx
• src/app/[others]/page.tsx
• src/backend/auth.api.ts
• src/backend/avatarGenerator.ts
• src/components/pages/user/index.tsx

Additional comments: 13

src/app/page.tsx (1)

• 5-5: The refactor to import getGithubStars from a separate helper file is a good practice for enhancing code modularity and maintainability. Well done on this change.

src/types/index.d.ts (1)

• 28-28: Removing the trailing space from the avatarURL property in the userDetail type is a good cleanup for consistency and readability.

src/styles/globals.css (3)

• 5-10: Setting universal styles for all elements is a good practice for ensuring consistency and resetting default browser styles. This contributes to a more polished user interface.
• 45-45: The .card component styles are well-defined using Tailwind's @apply directive, contributing to clean and maintainable CSS. Good job on this enhancement.
• 80-80: The .is-active style and the p:empty::before selector are specific enhancements that likely address particular UI requirements. These changes are well-implemented.

src/components/core/footer/index.tsx (3)

• 6-27: Dynamically rendering footer links based on generalList is a great improvement for maintainability and scalability. This approach allows for easier updates and additions to the footer links.
• 29-40: Similarly, using the helpSupport array for dynamically rendering help and support links is an excellent practice. It enhances the component's flexibility and maintainability.
• 98-103: Updating the copyright text and adding developer credits are good practices for keeping the footer content relevant and up-to-date. Well done on these updates.

src/components/core/navbar/index.tsx (1)

• 36-42: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [39-82]

Uncommenting the useEffect hook in the Navbar component to fetch the current user and handle a timeout for clearing console logs is a significant improvement. It enhances the component's initialization logic and ensures proper cleanup, which is crucial for performance and avoiding memory leaks.

src/app/(support)/terms/page.tsx (1)

• 7-116: The structure and setup of the Terms page, including the use of the SupportHeader component, are well-implemented. Ensure that the placeholder text (Lorem ipsum) is replaced with the actual terms of service content before the page goes live.

src/components/pages/auth/register/index.tsx (3)

• 44-44: The removal of setRegisterStatus("registering") affects the control flow related to the registration status. This change might impact how the application's state is managed during the registration process. Ensure that the removal of this line does not leave the application in an inconsistent state or affect user feedback mechanisms during registration.
• 42-48: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

The use of "use client"; at the top of the file is a good practice for Next.js components that are intended to run only on the client side. This ensures that Next.js optimizes the component for client-side execution.

• 42-48: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [90-90]

The UI components and animations provided by framer-motion enhance the user experience by making the registration page more dynamic and engaging. This use of motion effects is a good practice for improving visual feedback and user interaction.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 69dff7c and 6f3d417.

Files selected for processing (2)

• src/app/(support)/privacy/page.tsx (1 hunks)
• src/app/(support)/terms/page.tsx (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• src/app/(support)/privacy/page.tsx
• src/app/(support)/terms/page.tsx

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6f3d417 and ce46833.

Files selected for processing (1)

• .eslintrc.json (1 hunks)

Additional comments: 1

.eslintrc.json (1)

• 4-4: Disabling the react/no-unescaped-entities rule can make JSX code cleaner in cases where characters that could be considered HTML entities are used intentionally. However, it's important to ensure this doesn't lead to overlooking characters that should be escaped to prevent security issues, such as XSS vulnerabilities. Please ensure that other security measures or linters are in place to mitigate any potential risks introduced by this change.