0me9a / devfinder Goto Github PK

The search button still work when the input value is empty and then it results in showing not found. So input validation should be added to stop this behaviour.

Title: Upgrade devFiender to Next.js framework with TypeScript and Tailwind CSS styles

Description:

The current devFiender website is built using pure React. To enhance the development experience and maintainability of the project, we propose upgrading the website to the Next.js framework with TypeScript and Tailwind CSS styles.

Benefits of upgrading to Next.js framework:

• Server-side rendering: Next.js enables server-side rendering, improving performance and SEO.
• File-system-based routing: Next.js uses file-system-based routing, making it easier to manage routes and create dynamic page layouts.
• Data fetching and caching: Next.js provides built-in support for data fetching and caching, simplifying data handling and improving performance.

Benefits of using Tailwind CSS styles:

• Utility-first approach: Tailwind CSS provides a utility-first approach to styling, making it easier to style components and create consistent designs.
• Responsive design: Tailwind CSS facilitates the creation of responsive designs by offering a set of utility classes for different screen sizes.
• Dark mode: Tailwind CSS includes built-in support for dark mode, making it easy to switch between light and dark themes.

Tasks:

1. Install Next.js, TypeScript, and Tailwind CSS dependencies.
2. Convert existing React components to Next.js components with TypeScript.
3. Implement server-side rendering for pages.
4. Configure Tailwind CSS and import the CSS file.
5. Apply Tailwind CSS utility classes to style components.
6. Update routing to use file-system-based routing provided by Next.js.
7. Implement data fetching and caching for components using Next.js capabilities.
8. Update tests and documentation to reflect the new architecture.

Acceptance criteria:

• The website should be fully functional using Next.js, TypeScript, and Tailwind CSS.
• The website should be performant and SEO-friendly.
• The code should be clean, maintainable, and well-tested.

Add History Section with Local Storage Support

Description:
The devFinder website lacks a history section displaying previously searched developers. It would benefit users if we implemented a history feature showcasing their search history. Additionally, using local storage to persist the data after a page refresh would enhance the user experience.

Tasks:

1. Implement a history section on the devFinder website to display a list of previously searched developers.
2. Utilize local storage to store the search history data.
3. Set an expiry time for the stored data to prevent it from persisting indefinitely.

Acceptance Criteria:

• The history section should be clearly visible and easily accessible.
• The section should display a list of previously searched developers, including relevant information.
• The search history data should be stored in local storage.
• Implement an expiry mechanism for the stored data to prevent it from being kept indefinitely.

Additional Information:

• Consider providing a clear way for users to manage or clear their search history.
• Enhancing the user interface for the history section is encouraged.

Note:
Adding a history section will improve user engagement and allow users to revisit or track their previous searches conveniently.

Issue: Remove Cookie Permission Prompt for Improved User Experience

Description:
The current implementation of the devFinder website includes a cookie permission prompt, requesting user consent to use cookies. However, the website does not currently utilize cookies for storing data, and all data is managed through local storage.

Recommendation:
Considering that the website does not rely on cookies and there are no immediate plans to use them, it would be beneficial to remove the cookie permission prompt. Unnecessary prompts can impact the user experience, and users might find it more straightforward without the prompt when cookies are not being utilized.

Tasks:

1. Identify the locations in the codebase where the cookie permission prompt is implemented.
2. Remove or comment out the relevant code sections related to the cookie permission prompt.
3. Test the website to ensure that the cookie permission prompt no longer appears.
4. Update any relevant documentation to reflect the removal of the cookie permission prompt.

Additional Consideration:
If there are plans to implement cookie usage in the future, a note in the documentation can inform contributors about potential changes to the cookie policy.

Note:
Removing the unnecessary cookie permission prompt will contribute to a cleaner and more straightforward user experience, aligning with the current functionality of the devFinder website.

Issue: Inconsistent Theme Toggling During GitHub User Search

Description:
Currently, the devFinder website exhibits inconsistent behaviour with theme toggling when a user performs a search for a GitHub user. Upon each search action, the theme automatically toggles between dark and light modes, causing confusion and disrupting the user experience.

Steps to Reproduce:

Visit the devFinder website.
Perform a search for a GitHub user.
Note that the theme toggles between dark and light modes unexpectedly.
Expected Behavior:
The theme should maintain its state consistently regardless of user actions such as searching for a GitHub user. The theme preference chosen by the user should persist throughout the browsing session without unexpected toggling.

Additional Information:
Inconsistent theme toggling can lead to user confusion and disrupt the overall browsing experience. Addressing this issue will contribute to a smoother and more predictable user interaction with the devFinder website.

Theme Toggle Button Not Responsive

Description:
The theme toggle button in the devFinder website is currently not responsive to user clicks, and it fails to change the theme as expected. Users are unable to toggle between light and dark themes using the provided button.

Steps to Reproduce:

1. Open the devFinder website.
2. Locate the theme toggle button.
3. Click on the theme toggle button to switch between light and dark themes.

Expected Behavior:
The theme toggle button should be responsive to user clicks, and the theme of the website should change accordingly, providing a seamless transition between light and dark modes.

Actual Behavior:
The theme toggle button does not respond to clicks, and the theme remains unchanged.

Additional Information:

• The issue occurs consistently across different browsers.
• Ensure that the necessary state changes and theme-switching logic are implemented correctly.

Note:
This issue affects the user experience and visual preferences of the website, and resolving it will enhance the overall usability of the devFinder application.

Issue: UI Order for Repository, Followers, and Following

Description:
Currently, there is a minor inconsistency in the UI order for displaying the repository, followers, and following information on the devFinder website. The expected order should be "repository", "followers", and "following". However, the current order displays "following", "repository", and "followers", which deviates from the expected sequence.

Tasks:

• Adjust the UI order to display "repository", "followers", and "following" in that sequence.

Acceptance Criteria:

• The UI order for displaying repository, followers, and following information should be "repository", "followers", and "following".
• Ensure the changes are applied consistently across all relevant components and pages.

Additional Information:

• Maintaining a consistent and logical UI order improves user experience and ensures clarity in presenting information.
• Verify the changes across different screen sizes to ensure responsiveness and readability.

Update README.md

Description:
The README.md file serves as a crucial source of information for developers and contributors. It's essential to keep it up-to-date with relevant information about the project, its structure, and how to contribute. This issue aims to address any outdated information and enhance the overall readability and completeness of the README.md file.

Tasks:

1. Review and update the project description to reflect the current state and purpose of devFinder.
2. Ensure that installation instructions are accurate and cover all dependencies.
3. Include instructions on how to run and test the project locally.
4. Provide guidelines for contribution, including how to submit issues and pull requests.
5. Add a section about the project's architecture, code organization, and any essential concepts.
6. Include information about project configuration, environment variables, or any necessary setup steps.
7. Verify that all external dependencies and their versions are clearly documented.
8. Ensure that badges, such as build status or license information, are accurate and up-to-date.

Acceptance Criteria:

• The README.md file should be well-organized, easy to understand, and informative.
• All information in the README should accurately reflect the current state of the project.
• Contributors, whether new or experienced, should find it easy to get started with the project.

Note:
A well-maintained README.md file is crucial for attracting new contributors and providing a smooth onboarding experience for developers interested in the project.

Create About Page

Description:
We currently do not have an "About" page on the devFinder website. It would be beneficial to create a dedicated page that provides information about the purpose of devFinder, its features, and possibly some background about the creator.

Tasks:

• Design a simple and informative layout for the About page.
• Include a section detailing the purpose and goals of devFinder.
• Provide information about the features and functionalities of devFinder.
• Consider adding a brief bio or background about the creator (Baliram Singh, also known as OMEGA).
• Ensure that the page is visually appealing and consistent with the overall design of the website.
• Implement navigation to the About page from the main menu.

Acceptance Criteria:

• The About page should be accessible from the main menu.
• The content on the About page should be well-organized and easy to read.
• Information about devFinder's purpose, features, and the creator should be included.
• The page should maintain a consistent design with the rest of the website.
• All links and navigation should function correctly.

Additional Information:
Creating an About page will provide users with valuable context about the devFinder platform and the motivation behind its development. It contributes to a more engaging and transparent user experience.

Feature Request: Fetch and Display Repository, Followers, and Following Lists

Description:
Currently, the devFinder website provides basic information about GitHub users. To enhance the user experience and provide more comprehensive insights into GitHub users, it would be beneficial to fetch and display additional details such as repository lists, followers, and following lists directly from the GitHub API.

Tasks:

1. Implement functionality to fetch and display the repository list of GitHub users.
2. Implement functionality to fetch and display the list of followers for each GitHub user.
3. Implement functionality to fetch and display the list of users that a GitHub user is following.

Acceptance Criteria:

• The website should fetch and display the repository list, followers, and following lists for GitHub users upon user request.
• Ensure that the fetched data is accurate and up-to-date, reflecting the user's GitHub profile information.
• Implement appropriate error handling in case the GitHub API requests fail or encounter errors.
• Verify the performance and responsiveness of the feature to ensure a smooth user experience.

Additional Information:

• Providing detailed information about GitHub users directly within the devFinder website will improve its utility and user engagement.
• Consider implementing pagination or lazy loading for large repository, followers, and following lists to optimize performance and user experience.