Skip to content

Improve README with setup instructions #3605

@dharsh19v

Description

@dharsh19v

Is your feature request related to a problem? Please describe.

Yes, the current application does not provide clear feedback when data is being fetched or processed. This can make users confused, as they may think the application is not working or has become unresponsive.

Additionally, the lack of clear documentation makes it difficult for beginners to understand how to set up and run the project. This creates a barrier for new contributors who want to get started.

Describe the solution you'd like

I would like to implement a clear and user-friendly solution to improve the overall experience.

For the UI/feature improvement, I propose adding a loading indicator (such as a spinner or progress bar) that appears while data is being fetched or processed. This will provide visual feedback to users and make the application feel more responsive.

Additionally, for better accessibility and contribution, I would like to improve the README by adding a structured "Getting Started" section with step-by-step instructions for installation and running the project locally.

These changes will make the application more intuitive for users and easier for beginners to contribute.

Describe alternatives you've considered

I have considered alternative approaches such as leaving the current behavior unchanged or providing only minimal improvements like adding text-based status messages.

However, these approaches may not provide a clear and intuitive experience for users. For example, without a proper loading indicator, users may still feel uncertain about whether the application is working.

Similarly, without structured documentation, beginners may continue to face difficulties in understanding the setup process.

Therefore, implementing a visual loading indicator and improving the README documentation are more effective and user-friendly solutions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions