Skip to content

Update README with use case and port information #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2025
Merged

Update README with use case and port information #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ This project began as a private service built for a company. Later, my client an
| **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 |
Copy link

Copilot AI Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected spelling of 'Porrt' to 'Port'.

Suggested change
| Use Case | Porrt | Description |
| Use Case | Port | Description |

Copilot uses AI. Check for mistakes.
|----------|--------|-------------|
| **Front-end** | 8080 | Front-end Front-end User |
Copy link

Copilot AI Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description 'Front-end Front-end User' contains redundant text and is unclear. Consider revising to something like 'Front-end application user interface'.

Suggested change
| **Front-end** | 8080 | Front-end Front-end User |
| **Front-end** | 8080 | Front-end application user interface |

Copilot uses AI. Check for mistakes.
| **Backend** | 3001 | Backend port required |
Copy link

Copilot AI Oct 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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'.

Suggested change
| **Backend** | 3001 | Backend port required |
| **Backend** | 3001 | Backend API service port |

Copilot uses AI. Check for mistakes.
| **Website** | 80 | Website needs to be protected |
| **Website** | 443 | Website needs to be protected |


### 🖥️ Production Deployment (New Server)

```bash
Expand Down