Update README with use case and port information #25
Conversation
Added use case section with port descriptions for front-end, backend, and website.
|
There was a problem hiding this comment.
Pull Request Overview
Updates the README documentation by adding a new use case section that describes port configurations for different application components.
- Added a table documenting port assignments for front-end, backend, and website components
- Provided descriptions for each port's purpose and security requirements
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| | **Development/Testing** | `./scripts/quickstart.sh` | Quick run in dev mode (no Nginx installation, no root required) | | ||
| | **Upgrade New Version** | `./scripts/update.sh` | Full update to new version | | ||
|
|
||
| | Use Case | Porrt | Description | |
There was a problem hiding this comment.
Corrected spelling of 'Porrt' to 'Port'.
| | Use Case | Porrt | Description | | |
| | Use Case | Port | Description | |
|
|
||
| | Use Case | Porrt | Description | | ||
| |----------|--------|-------------| | ||
| | **Front-end** | 8080 | Front-end Front-end User | |
There was a problem hiding this comment.
The description 'Front-end Front-end User' contains redundant text and is unclear. Consider revising to something like 'Front-end application user interface'.
| | **Front-end** | 8080 | Front-end Front-end User | | |
| | **Front-end** | 8080 | Front-end application user interface | |
| | Use Case | Porrt | Description | | ||
| |----------|--------|-------------| | ||
| | **Front-end** | 8080 | Front-end Front-end User | | ||
| | **Backend** | 3001 | Backend port required | |
There was a problem hiding this comment.
The description 'Backend port required' is vague and doesn't explain the purpose of the backend service. Consider a more descriptive explanation like 'Backend API service port'.
| | **Backend** | 3001 | Backend port required | | |
| | **Backend** | 3001 | Backend API service port | |
Added use case section with port descriptions for front-end, backend, and website.