From 5c1e0dbebe9db4b4131b7f0a5412ab0e72fa81e6 Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:25:48 -0400 Subject: [PATCH 01/12] Table of Contents Added a table of contents to help easily route new contributors to different sections of the README. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index d693a25..b5b029b 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,23 @@ An Uber Eats style delivery platform running on Medusa 2.0 and Next.js 14.

+# Table of Contents + +1. [Overview](#overview) +2. [Project Structure](#project-structure) +3. [Quickstart](#quickstart) + - [Install dependencies](#install-dependencies) + - [Set up environment variables](#set-up-environment-variables) + - [Set up and seed the database](#set-up-and-seed-the-database) + - [Start developing](#start-developing) +4. [Create User Accounts](#create-user-accounts) + - [Create restaurant admin account](#create-restaurant-admin-account) + - [Create driver account](#create-driver-account) +5. [Place an Order and Handle a Delivery](#place-an-order-and-handle-a-delivery) +6. [Resources](#resources) + - [Learn more about Medusa](#learn-more-about-medusa) + - [Learn more about Next.js](#learn-more-about-nextjs) + # Overview Medusa Eats is built with: From bf38a5ce9a5c070d782b672f1c2309b090eab94f Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:27:21 -0400 Subject: [PATCH 02/12] Updated Table of Contents Fixed the subheadings of the table of contents. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b5b029b..8e3fd29 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,10 @@ An Uber Eats style delivery platform running on Medusa 2.0 and Next.js 14.

- [Set up environment variables](#set-up-environment-variables) - [Set up and seed the database](#set-up-and-seed-the-database) - [Start developing](#start-developing) -4. [Create User Accounts](#create-user-accounts) + - [Create User Accounts](#create-user-accounts) - [Create restaurant admin account](#create-restaurant-admin-account) - [Create driver account](#create-driver-account) -5. [Place an Order and Handle a Delivery](#place-an-order-and-handle-a-delivery) + - [Place an Order and Handle a Delivery](#place-an-order-and-handle-a-delivery) 6. [Resources](#resources) - [Learn more about Medusa](#learn-more-about-medusa) - [Learn more about Next.js](#learn-more-about-nextjs) From b4731aa65d092feb939717e6b0ce3feab54c0617 Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:28:20 -0400 Subject: [PATCH 03/12] Updated Table of Contents Fixed subheadings --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 8e3fd29..e3cc812 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,6 @@ An Uber Eats style delivery platform running on Medusa 2.0 and Next.js 14.

- [Set up and seed the database](#set-up-and-seed-the-database) - [Start developing](#start-developing) - [Create User Accounts](#create-user-accounts) - - [Create restaurant admin account](#create-restaurant-admin-account) - - [Create driver account](#create-driver-account) - [Place an Order and Handle a Delivery](#place-an-order-and-handle-a-delivery) 6. [Resources](#resources) - [Learn more about Medusa](#learn-more-about-medusa) From 483b506793b037618dfb4ccc9e4afe5581b461fc Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:32:38 -0400 Subject: [PATCH 04/12] Added title to frontend documentation --- frontend/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/frontend/README.md b/frontend/README.md index c403366..b417f90 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,3 +1,5 @@ +### Frontend Overview + This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). ## Getting Started From 52d71a767c671602c7a50856c9948e59cf0671ab Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:33:37 -0400 Subject: [PATCH 05/12] Update Frontend readme --- frontend/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/README.md b/frontend/README.md index b417f90..29182d9 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,4 +1,4 @@ -### Frontend Overview +

Frontend Overview

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). From b5390a2a539c0ebabd63677e4d4bd86a07ce0c89 Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 11:35:51 -0400 Subject: [PATCH 06/12] Added contribution section --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e3cc812..527da8e 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,8 @@ An Uber Eats style delivery platform running on Medusa 2.0 and Next.js 14.

- [Start developing](#start-developing) - [Create User Accounts](#create-user-accounts) - [Place an Order and Handle a Delivery](#place-an-order-and-handle-a-delivery) -6. [Resources](#resources) +4. [Contribute](#contribute) +5. [Resources](#resources) - [Learn more about Medusa](#learn-more-about-medusa) - [Learn more about Next.js](#learn-more-about-nextjs) @@ -182,6 +183,8 @@ We're gonna create a restaurant admin and driver account so we'll have access to 10. The accepted order will show up on your dashboard. Click the button to claim it. 11. The order will go through the different stages on all dashboards in realtime. You can progress the order by marking each stage as complete on the relevant dashboard. +# Contribute + # Resources ## Learn more about Medusa From 83878086d2ef72c9012307c6ea5e4348cd0c203e Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:01:29 -0400 Subject: [PATCH 07/12] Added contribution guide to README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 527da8e..45a643d 100644 --- a/README.md +++ b/README.md @@ -185,6 +185,32 @@ We're gonna create a restaurant admin and driver account so we'll have access to # Contribute +Follow the steps below to contribute to this project: + +### 1. Fork the Repository + +- Start by forking the repository to create your own copy. + +### 2. Browse the Issues + +- Head over to the [Issues tab](link-to-issues) to view open issues. +- If you find an issue you want to work on, leave a comment to request being assigned to it. + +### 3. Open a New Issue + +- If you find a bug or have a feature idea that isn’t already listed, [open a new issue](link-to-create-an-issue). +- In your issue, provide a clear description and reasoning behind the bug or idea. + +### 4. Make Changes in Your Fork + +- After being assigned an issue, clone your forked repository to your local machine. +- Create a new branch for your changes, using a descriptive name. + +### 6. Merging Code + +- Make sure your changes don't conflict with existing functionalities +- Push your changes to your forked repository and raise a pull request to the original repository + # Resources ## Learn more about Medusa From 9cc46b70f0a304229e0e1fa29169b0c11498092e Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:03:25 -0400 Subject: [PATCH 08/12] Updated Overview --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 45a643d..c74f3d7 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@

-An Uber Eats style delivery platform running on Medusa 2.0 and Next.js 14.

+Medusa Eats ia a fullstack food delivery platform, inspired by Uber Eats, running on Medusa 2.0 and Next.js 14.

From e26443eb1d95b5916252042bb3b7325022b9e008 Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:07:00 -0400 Subject: [PATCH 09/12] Added more context to backend and frontend --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c74f3d7..72082da 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,9 @@ Features include: The project consists of two main directories: - `/backend` contains the Medusa 2.0 project with all the customizations. + - This handles core functionalities, including user authentication, order management, and more. - `/frontend` contains the Next.js project. + - This handles the user interface, restaruant storefronts, dashboards, and more. # Quickstart From 0d5c4deabbc20d554897688ea08d9178390ed40c Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:16:02 -0400 Subject: [PATCH 10/12] Updated contribution guide --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 72082da..413b137 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,9 @@ We're gonna create a restaurant admin and driver account so we'll have access to # Contribute +We happily welcome contributions to this project! +Note: Please review the source code and ensure you have a thorough understanding of it before making any changes. + Follow the steps below to contribute to this project: ### 1. Fork the Repository From cd5ce18c3f5daf81dcb519fe59973a5570267046 Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:16:31 -0400 Subject: [PATCH 11/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 413b137..0fba345 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ We're gonna create a restaurant admin and driver account so we'll have access to # Contribute We happily welcome contributions to this project! -Note: Please review the source code and ensure you have a thorough understanding of it before making any changes. + - Note: Please review the source code and ensure you have a thorough understanding of it before making any changes. Follow the steps below to contribute to this project: From 865cdc3b8396a4ce135ead0a4b61f0d6c8255d73 Mon Sep 17 00:00:00 2001 From: Christian Mundreanu <155108015+Mundreanuc223@users.noreply.github.com> Date: Wed, 25 Sep 2024 12:17:30 -0400 Subject: [PATCH 12/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fba345..71c1d55 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ We're gonna create a restaurant admin and driver account so we'll have access to # Contribute We happily welcome contributions to this project! - - Note: Please review the source code and ensure you have a thorough understanding of it before making any changes. +

Note: Please review the source code and ensure you have a thorough understanding of it before making any changes

Follow the steps below to contribute to this project: