Improved README with architecture, better navigation and cleaner structure!#197
Open
niyatisharma100307-crypto wants to merge 2 commits into
Open
Conversation
Contributor
Author
|
Any update?! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR focuses on improving the main project README to make onboarding, navigation, and contribution guidance clearer, aligning with issue #137’s request for better quick start, architecture visibility, and contributor workflow documentation.
Changes:
- Reworked README structure and navigation (updated header, TOC, reorganized sections).
- Added onboarding enhancements (prerequisites table, clearer quick start steps, troubleshooting details).
- Expanded contributor guidance (branch naming, commit format, PR checklist, code style notes) and added an architecture diagram.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+141
to
145
| psql --version # expect 14+ | ||
| git --version | ||
| ======= | ||
| - Node.js 18.0 or higher | ||
| - npm 9.0 or higher (comes with Node.js) |
Comment on lines
+291
to
297
| ```env | ||
| # Spring Boot context path — no trailing slash | ||
| VITE_API_BASE_URL=http://localhost:8181/restroly | ||
| ======= | ||
| #### 2. Environment configuration - Google OAuth | ||
|
|
||
| Create a `.env` file in `RestroHub-FrontEnd/` (see `.env.example`): |
Comment on lines
+309
to
313
|
|
||
| # Optional | ||
| VITE_NODE_ENV=development | ||
| VITE_ENABLE_ANALYTICS=false | ||
| ``` |
| ├── CONTRIBUTING.md | ||
| ├── LICENSE | ||
| └── CONTRIBUTING.md | ||
| └── README.md |
| <summary><strong>Gradle wrapper JAR missing</strong></summary> | ||
|
|
||
| ```bash | ||
| gradle wrapper --gradle-version 8.7 |
Comment on lines
+437
to
+440
| | `GET` | `/api/v1/menus` | List all menus | | ||
| | `POST` | `/api/v1/menus` | Create a menu | | ||
| | `PUT` | `/api/v1/menus/{id}` | Update a menu | | ||
| | `DELETE` | `/api/v1/menus/{id}` | Delete a menu | |
Comment on lines
442
to
+461
| #### Categories | ||
| - `GET /api/v1/categories` - Get all categories | ||
| - `POST /api/v1/categories` - Create category | ||
| | Method | Endpoint | Description | | ||
| |--------|----------|-------------| | ||
| | `GET` | `/api/v1/categories` | List all categories | | ||
| | `POST` | `/api/v1/categories` | Create a category | | ||
|
|
||
| #### Food Items | ||
| - `GET /api/v1/foods` - Get all food items | ||
| - `POST /api/v1/foods` - Add food item | ||
| - `PUT /api/v1/foods/{id}` - Update food item | ||
| - `DELETE /api/v1/foods/{id}` - Delete food item | ||
| | Method | Endpoint | Description | | ||
| |--------|----------|-------------| | ||
| | `GET` | `/api/v1/foods` | List all food items | | ||
| | `POST` | `/api/v1/foods` | Add a food item | | ||
| | `PUT` | `/api/v1/foods/{id}` | Update a food item | | ||
| | `DELETE` | `/api/v1/foods/{id}` | Delete a food item | | ||
|
|
||
| #### Orders | ||
| - `GET /api/v1/orders` - Get all orders | ||
| - `POST /api/v1/orders` - Place new order | ||
| - `GET /api/v1/orders/{id}` - Get order details | ||
| | Method | Endpoint | Description | | ||
| |--------|----------|-------------| | ||
| | `GET` | `/api/v1/orders` | List all orders | | ||
| | `POST` | `/api/v1/orders` | Place a new order | | ||
| | `GET` | `/api/v1/orders/{id}` | Get order details | |
Owner
|
Hi @niyatisharma100307-crypto , |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What I changed in this PR!!
🗑️ Removed
➕ Added
🔧 Fixed
(caused by special emoji characters that GitHub couldn't read)
♻️ Improved
📄 Type of change
closes #137