-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.@@ -27,6 +27,22 @@ 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) + - [Create User Accounts](#create-user-accounts) + - [Place an Order and Handle a Delivery](#place-an-order-and-handle-a-delivery) +4. [Contribute](#contribute) +5. [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: @@ -51,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 @@ -167,6 +185,37 @@ 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 + +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 + +- 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 diff --git a/frontend/README.md b/frontend/README.md index c403366..29182d9 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -1,3 +1,5 @@ +