Non‐functional requirements - NMSU-CS-CS371/team-project-real-wheretonext GitHub Wiki

1. Hardware and External Software Requirements

WhereToNext application is a lightweight desktop built application using java, java swing, and integrates with the help of Yelp API.

• Compatible with Windows, macOs, or linux
• Any standard computer (laptop or desktop)
• Internet connection for API requests

2. Security

WhereToNext application interacts with external API and handles user input.

• Yelp API key (must be kept private not hard coded)
• Validate and sanitize user input to prevent issues
• Malicious or unexpected user input

3. Performance

This system should provide a smooth and responsive experience for users.

• API response should be displayed within 1-3 seconds
• UI interactions (buttons clicks, typing) should feel instant( <0.5 seconds)
• The system should handle multiple searches without crashing and freezing

4. Usability

This application is designed for casual users looking for quick recommendations and help with trips

• General Users (students, travelers, locals)
• No technical background required
• Simple and intuitive interface (search bar + results display)
• Minimal steps to get results

5. Reliability

The system should be stable and handle errors gracefully

• Handles exceptions (IOExceptions, API errors)
• Should not crash due to invalid user input, API request failures and network issues
• API should still run locally even if API fails (with error notice)