Skip to content

Missing API URL in Readme File #1

@MhmodTayel

Description

@MhmodTayel

Issue Description:

The current README file lacks the URL to access the API documentation and interact with the mock server. As a result, users and potential contributors are unable to find the appropriate endpoint to test the API's functionality.

Expected Behavior:

The README file should provide a clear and easily accessible link to the API documentation and mock server URL.

Steps to Reproduce:

  1. Go to the README file of the repository.
  2. Look for the section that should contain the API details and its related URLs.
  3. Observe that the URL for accessing the API documentation and mock server is not provided.

Additional Information:

The API is designed to facilitate bar counters for self-serving attendees. It monitors the flow of beverages, and based on the price, calculates the total amount. The README should include a link to the API documentation and mock server URL to allow users to explore and test the API's features.

Proposed Solution:

Add a clear and prominently visible section in the README file that includes the URL to the API documentation and mock server. This will help users quickly find the necessary information to interact with the API and explore its functionality.

Impact:

This missing information can cause confusion among users and hinder adoption and contribution to the project. Providing the API URL in the README will enhance accessibility and make it easier for developers to get started with the API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions