-
Notifications
You must be signed in to change notification settings - Fork 1
docs: improve setup instructions and standardize port configuration #13
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.
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
base: main
Are you sure you want to change the base?
Conversation
- Update README.md to reference port 5173 instead of 3000 - Update .env.example FRONTEND_URL to port 5173 - Remove hardcoded port 3000 from server.js CORS origins - Fix test file API_BASE_URL to use correct backend port 8000
- Add numbered instructions for creating OAuth App at github.com/settings/developers - Document the required callback URL: http://localhost:8000/api/auth/github/callback - Clarify OAuth scopes used (user:email, repo) - Note distinction between OAuth Apps and GitHub Apps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR standardizes the frontend port configuration from 3000 to 5173 (Vite's default) and significantly improves the developer onboarding experience by adding detailed GitHub OAuth setup instructions.
Key Changes:
- Standardized all port references to 5173 for frontend and 8000 for backend
- Added comprehensive step-by-step GitHub OAuth App setup guide
- Fixed incorrect backend port reference in integration tests (3000 → 8000)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
backend/test/cache.integration.test.js |
Updated backend API port from 3000 to 8000 and applied consistent indentation formatting |
backend/src/server.js |
Removed hardcoded port 3000 from CORS origin array, keeping only the configured frontend URL |
backend/.env.example |
Updated FRONTEND_URL from port 3000 to 5173 to match Vite's default |
README.md |
Updated all port references, added detailed GitHub OAuth setup instructions with callback URLs and required scopes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| origin: [FRONTEND_URL, 'http://localhost:3000', 'http://localhost:5173'], | ||
| origin: [FRONTEND_URL, 'http://localhost:5173'], | ||
| credentials: true | ||
| })); // Allow requests from multiple frontend ports |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The comment "Allow requests from multiple frontend ports" is misleading since the CORS configuration now only allows one frontend port (5173). The comment should be updated to reflect this change, or removed entirely since it now only allows the configured FRONTEND_URL and its default fallback.
| })); // Allow requests from multiple frontend ports | |
| })); |
| origin: [FRONTEND_URL, 'http://localhost:5173'], | ||
| credentials: true | ||
| })); // Allow requests from multiple frontend ports |
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The CORS origin array includes both FRONTEND_URL (which defaults to 'http://localhost:5173') and the hardcoded 'http://localhost:5173'. This creates redundancy when FRONTEND_URL is not explicitly set. Consider simplifying to just origin: FRONTEND_URL or keeping the array format only if multiple origins are genuinely needed for different deployment scenarios.
| origin: [FRONTEND_URL, 'http://localhost:5173'], | |
| credentials: true | |
| })); // Allow requests from multiple frontend ports | |
| origin: FRONTEND_URL, | |
| credentials: true | |
| })); // Allow requests from the frontend URL |
| Note: For the backend to start successfully you must set the GitHub OAuth environment variables in backend/.env (GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET). If these are not present the authentication routes will fail and the app may not start depending on your local configuration. | ||
|
|
Copilot
AI
Dec 10, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] This note is a single, very long sentence that's difficult to read. Consider breaking it into multiple sentences or using a bulleted list for better readability. For example:
"Note: For the backend to start successfully, you must set the GitHub OAuth environment variables in backend/.env:
GITHUB_CLIENT_IDGITHUB_CLIENT_SECRET
If these are not present, the authentication routes will fail and the app may not start depending on your local configuration."
| Note: For the backend to start successfully you must set the GitHub OAuth environment variables in backend/.env (GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET). If these are not present the authentication routes will fail and the app may not start depending on your local configuration. | |
| **Note:** For the backend to start successfully, you must set the GitHub OAuth environment variables in `backend/.env`: | |
| - `GITHUB_CLIENT_ID` | |
| - `GITHUB_CLIENT_SECRET` | |
| If these are not present, the authentication routes will fail and the app may not start depending on your local configuration. |
Summary
This PR improves the documentation and standardizes the frontend port configuration.
Changes
Port Standardization
README.mdinstructions.env.examplewith correctFRONTEND_URLOAuth Documentation
user:emailandrepo)Testing
npm run start:frontend- should start on port 5173