steve
/
grocery-app
mirror of https://github.com/ninjas-code-official/food-delivery-singlevendor
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #14 from Ninjas-Code-official/readme-updated 

Update README.md
This commit is contained in:
aliamerce 2023-09-27 13:04:27 +05:00 committed by GitHub
parent 726bd75055 ef41326444
commit 3494942113
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 117 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

177
README.md
View File

@ -1,12 +1,83 @@
# Enatega Single Vendor Solution <div align="right">
<a target="_blank" href="https://www.facebook.com/sharer/sharer.php?u=https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution" style="text-decoration:none">
<img src="https://img.shields.io/badge/-0d1117?logo=facebook" width="40" height="30">
</a>
<a target="_blank" href="https://www.linkedin.com/shareArticle?mini=true&url=https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution" style="text-decoration:none">
<img src="https://img.shields.io/badge/-0d1117?logo=linkedin" width="40" height="30">
</a>
<a target="_blank" href="https://twitter.com/intent/tweet?&url=https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution&via=TWITTER-HANDLE" style="text-decoration:none">
<img src="https://img.shields.io/badge/-0d1117?logo=twitter" width="40" height="30">
</a>
</div>
<div align="center">
<h2>Enatega Single-vendor</h2>
<i>Enatega is an open-source delivery management platform for the future.</i>
<br/>
<br />
</div>
<div align="center">
[![Static Badge](https://img.shields.io/badge/License-MIT-red)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/blob/main/LICENSE)
[![Stars](https://img.shields.io/github/stars/Ninjas-Code-official/Enatega-Food-Delivery-Solution.svg)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/stargazers)
[![Forks](https://img.shields.io/github/forks/Ninjas-Code-official/Enatega-Food-Delivery-Solution.svg)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/forks)
[![GitHub contributors](https://img.shields.io/github/contributors/Ninjas-Code-official/Enatega-Food-Delivery-Solution)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/graphs/contributors)
[![Open Pull Requests](https://img.shields.io/github/issues-pr-raw/Ninjas-Code-official/Enatega-Food-Delivery-Solution.svg)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/pulls)
[![Activity](https://img.shields.io/github/last-commit/Ninjas-Code-official/Enatega-Food-Delivery-Solution.svg)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/commits/main)
[![YouTube Channel](https://img.shields.io/badge/Watch_us-Youtube-red)](https://www.youtube.com/@ninjascode509)
[![Company Website](https://img.shields.io/badge/Visit_us-Website-blue)](https://enatega.com)
[![Closed Issues](https://img.shields.io/github/issues-closed/Ninjas-Code-official/Enatega-Food-Delivery-Solution?color=success)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/issues?q=is%3Aissue+is%3Aclosed)
[![Closed Pull Requests](https://img.shields.io/badge/Closed%20Pull%20Requests-View%20on%20GitHub-blue.svg)](https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/pulls?q=is%3Apr+is%3Aclosed)
</div>
<div align="center">
[![Static Badge](https://img.shields.io/badge/facebook-blue?logo=facebook&logoColor=Blue&color=%23fbfbfb)](https://www.facebook.com/enatega)
[![Static Badge](https://img.shields.io/badge/Instagram-blue?logo=instagram&logoColor=D815BE&color=%23fcfcfc)](https://www.instagram.com/enatega.nb/)
[![Static Badge](https://img.shields.io/badge/Twitter-blue?logo=Twitter&logoColor=blue&color=%23fcfcfc)](https://twitter.com/EnategaA)
[![Static Badge](https://img.shields.io/badge/LinkedIn-blue?logo=LinkedIn&logoColor=darkblue&color=%23fcfcfc)](https://www.linkedin.com/company/14583783/)
</div>
# Enatega Single Vendor Solution
<div align="center">
<a href="https://www.youtube.com/watch?v=8sE7ivnFyo0&feature=youtu.be&ab_channel=NinjasCode">
<img src="https://enatega.com/wp-content/uploads/2023/09/final.jpg" alt="Demo video" style="border-radius: 6px; width: auto;">
</a>
</div>
![Project thumbnail](./contributingGuides/thumbnail.png)
<br/> <br/>
Enatega is a state of the art white label storefront delivery solution that allows business owners to easily manage their deliveries. Whether they have a restaurant, grocery store, pharmacy, winery or any similar storefront, Enatega will intuitively and instantly be able to automate their deliveries, and handle the logistics. Our solution provides the capability of order management, as well as separate applications for the rider and the customer. It also boasts a suit of features which allow for a greater range of customizability for customers in terms of item selection. Enatega is a state of the art white label storefront delivery solution that allows business owners to easily manage their deliveries. Whether they have a restaurant, grocery store, pharmacy, winery or any similar storefront, Enatega will intuitively and instantly be able to automate their deliveries, and handle the logistics. Our solution provides the capability of order management, as well as separate applications for the rider and the customer. It also boasts a suit of features which allow for a greater range of customizability for customers in terms of item selection.
<b>This is the full free source code of our solution, however the backend and API is proprietary and can be obtained via paid license.</b> <b>This is the full free source code of our solution, however the backend and API is proprietary and can be obtained via paid license.</b>
## What is included: <!-- Add a horizontal rule for separation -->
<hr/>
## :fast_forward: Quick Links
- [:book: What is included](#heading-1)
- [:rocket: Features](#heading-2)
- [:wrench: Setup](#heading-3)
- [:gear: Prerequisites](#heading-4)
- [:computer: Technologies](#heading-5)
- [:camera: Screenshots](#heading-6)
- [:triangular_ruler: High Level Architecture](#heading-7)
- [:page_with_curl: Documentation](#heading-8)
- [:movie_camera: Demo Videos](#heading-14)
- [:video_game: Demos](#heading-9)
- [:busts_in_silhouette: Contributors](#heading-14)
- [:warning: Disclaimer](#heading-12)
- [:email: Contact Us](#heading-13)
<!-- Add a horizontal rule for separation -->
<hr/>
## :question: What is included: <a id="heading-1"></a>
Our solution contains three separate modules. These include the admin panel, the delivery app and the rider app. Below, the capabilities of all three modules have been listed: Our solution contains three separate modules. These include the admin panel, the delivery app and the rider app. Below, the capabilities of all three modules have been listed:
@ -16,7 +87,8 @@ Our solution contains three separate modules. These include the admin panel, the
- The rider app can accept the orders and also allows for location based zoning as well as the ability to locate customer’s address via google map’s API integration. - The rider app can accept the orders and also allows for location based zoning as well as the ability to locate customer’s address via google map’s API integration.
## Features:
## :fire: Features: <a id="heading-2"></a>
- Analytics dashboard for the mobile app - Analytics dashboard for the mobile app
- Payment integration with Paypal and Stripe - Payment integration with Paypal and Stripe
@ -31,7 +103,7 @@ Our solution contains three separate modules. These include the admin panel, the
- Multiple variations of food items - Multiple variations of food items
- Push notifications for both mobile and web - Push notifications for both mobile and web
## Setup ## :repeat_one: Setup: <a id="heading-3"></a>
As we’ve mentioned above, the solution includes three separate modules. To setup these modules, follow the steps below: As we’ve mentioned above, the solution includes three separate modules. To setup these modules, follow the steps below:
@ -43,29 +115,25 @@ The version of nodejs should be between 14.0 to 16.0
-[Link to Video tutorial/demonstration of Setup](https://enatega.com/singlevendor-documentation/) -[Link to Video tutorial/demonstration of Setup](https://enatega.com/singlevendor-documentation/)
## Screenshots ## :framed_picture: Screenshots: <a id="heading-6"></a>
| Customer Menu | Customer Categories | Customer Items | | Customer App |
| :--------------------------------------------------: | :--------------------------------------------------: | :--------------------------------------------------: | | :--------------------------------------------------: |
| ![](./contributingGuides/screenshots/customer1.jpeg) | ![](./contributingGuides/screenshots/customer2.jpeg) | ![](./contributingGuides/screenshots/customer3.jpeg) | | ![](https://enatega.com/wp-content/uploads/2023/09/customer.jpg) |
| Rider Menu | Rider Orders | Rider Items Details | | Rider App |
| :-----------------------------------------------: | :-----------------------------------------------: | :-----------------------------------------------: | | :-----------------------------------------------:|
| ![](./contributingGuides/screenshots/rider1.jpeg) | ![](./contributingGuides/screenshots/rider2.jpeg) | ![](./contributingGuides/screenshots/rider3.jpeg) | | ![](https://enatega.com/wp-content/uploads/2023/09/rider-app.jpg) |
| Stats Overview | User Table | Food Items Editing | | Dashboard |
| :-----------------------------------------------: | :-----------------------------------------------: | :-----------------------------------------------: | | :-----------------------------------------------: |
| ![](./contributingGuides/screenshots/admin1.jpeg) | ![](./contributingGuides/screenshots/admin2.jpeg) | ![](./contributingGuides/screenshots/admin3.jpeg) | | ![](https://enatega.com/wp-content/uploads/2023/09/dashboard-scaled.jpg) |
## High Level Architecture ## :wrench: High Level Architecture: <a id="heading-7"></a>
![High Level Architecture](./contributingGuides/screenshots/HighArchitectDiagram.png) ![High Level Architecture](./contributingGuides/screenshots/HighArchitectDiagram.png)
- User Mobile App communicates with both API Server and [Amplitudes](https://amplitude.com/) analytics dashboard ## :information_source: Prerequisites: <a id="heading-4"></a>
- Web dashboard communicates with only API Server
- Rider App communicates with API Server
### Prerequisites:
##### App Ids for Mobile App in app.json ##### App Ids for Mobile App in app.json
@ -102,59 +170,46 @@ The version of nodejs should be between 14.0 to 16.0
##### NOTE: Email provider has been only been tested for gmail accounts ##### NOTE: Email provider has been only been tested for gmail accounts
## Technologies: ## :hammer_and_wrench: Technologies: <a id="heading-5"></a>
| Expo | React-Navigation | Apollo GraphQL | ReactJS | NodeJS | MongoDB | Firebase |
|:-------:|:------------:|:--------------:|:-------:|:------:|:-------:|:--------:|
| <a href="https://expo.dev/"><img src="https://enatega.com/wp-content/uploads/2023/09/expoicon.png" alt="Enatega Logos" width="100"></a>| <a href="https://reactnavigation.org/"><img src="https://enatega.com/wp-content/uploads/2023/09/react-navigation.png" alt="Enatega Logos" width="100"></a>| <a href="https://www.apollographql.com/"><img src="https://enatega.com/wp-content/uploads/2023/09/apollo.png" alt="Enatega Logos" width="100"></a>| <a href="https://reactjs.org/"><img src="https://enatega.com/wp-content/uploads/2023/09/react-native.png" alt="Enatega Logos" width="100"></a> | <a href="https://nodejs.org/en/"><img src="https://enatega.com/wp-content/uploads/2023/09/node.png" alt="Enatega Logos" width="100"></a> | <a href="https://www.mongodb.com/"><img src="https://enatega.com/wp-content/uploads/2023/09/mongoDB.png" alt="Enatega Logos" width="100"></a> | <a href="https://firebase.google.com/"><img src="https://enatega.com/wp-content/uploads/2023/09/firebase.png" alt="Enatega Logos" width="100"></a> |
- [Expo](https://expo.dev/) |React Native | React Router | GraphQL | ExpressJS | React Strap | Amplitude |
- [React Navigation](https://reactnavigation.org/) |:------------:|:------------:|:-------:|:---------:|:-----------:|:---------:|
- [Apollo GraphQL](https://www.apollographql.com/) |<a href="https://reactnative.dev/"><img src="https://enatega.com/wp-content/uploads/2023/09/react-native.png" alt="Enatega Logos" width="100"></a> | <a href="https://reactrouter.com/"><img src="https://enatega.com/wp-content/uploads/2023/09/react-router-svgrepo-com.png" alt="Enatega Logos" width="100"></a> |<a href="https://graphql.org/"><img src="https://enatega.com/wp-content/uploads/2023/09/graphQl.png" alt="Enatega Logos" width="100"></a> | <a href="https://expressjs.com/"><img src="https://enatega.com/wp-content/uploads/2023/09/expo.png" alt="Enatega Logos" width="100"></a> |<a href="https://reactstrap.github.io/"><img src="https://enatega.com/wp-content/uploads/2023/09/React-strap.png" alt="Enatega Logos" width="100"></a> | <a href="https://amplitude.com/"><img src="https://enatega.com/wp-content/uploads/2023/09/Amplitude.png" alt="Enatega Logos" width="100"></a> |
- [ReactJS](https://reactjs.org/)
- [NodeJS](https://nodejs.org/en/)
- [MongoDB](https://www.mongodb.com/)
- [Firebase](https://firebase.google.com/)
- [Amplitude](https://amplitude.com/)
- [React Native](https://reactnative.dev/)
- [React Router](https://reactrouter.com/)
- [GraphQL](https://graphql.org/)
- [ExpressJS](https://expressjs.com/)
- [React Strap](https://reactstrap.github.io/)
## Demos
- [Customer App Android](https://play.google.com/store/apps/details?id=com.enatega.vendor) ## :iphone: Demos: <a id="heading-9"></a>
[![Customer App Android](https://user-images.githubusercontent.com/551004/29770692-a20975c6-8bc6-11e7-8ab0-1cde275496e0.png)](https://play.google.com/store/apps/details?id=com.enatega.vendor) | Customer App | Rider App | Admin Dashboard |
| :---------------------------: | :----------------------------: | :----------------------------:|
| <a href="#heading-9" style="pointer-events: none;"><img src="https://enatega.com/wp-content/uploads/2023/09/LOGO-CUSTOMER.png" alt="Enatega Logos" width="150"></a>| <a href="#heading-9" style="pointer-events: none;"><img src="https://enatega.com/wp-content/uploads/2023/09/RIDER-APP-LOGO.png" alt="Enatega Logos" width="150"></a>|<a href="https://singlevendor-admin.enatega.com"><img src="https://enatega.com/wp-content/uploads/2023/09/dashboard.png" alt="Enatega Logos" width="150"></a> |
| <a href="https://play.google.com/store/apps/details?id=com.enatega.vendor"><img src="https://enatega.com/wp-content/uploads/2023/09/android_518705.png" alt="Android Logo" width="25"></a> <a href="https://apps.apple.com/pk/app/enatega/id1493209281"><img src="https://enatega.com/wp-content/uploads/2023/09/social_10096939.png" alt="iOS Logo" width="25"></a> |<a href="https://play.google.com/store/apps/details?id=com.enatega.rider"><img src="https://enatega.com/wp-content/uploads/2023/09/android_518705.png" alt="Android Logo" width="25"></a> <a href="https://apps.apple.com/pk/app/enatega-rider-app/id1493291047"><img src="https://enatega.com/wp-content/uploads/2023/09/social_10096939.png" alt="iOS Logo" width="25"></a> |
- [Customer App iOS](https://apps.apple.com/pk/app/enatega/id1493209281)
[![Customer App iOS](https://user-images.githubusercontent.com/551004/29770691-a2082ff4-8bc6-11e7-89a6-964cd405ea8e.png)](https://apps.apple.com/pk/app/enatega/id1493209281)
- [Rider App Android](https://play.google.com/store/apps/details?id=com.enatega.rider)
[![Rider App Android](https://user-images.githubusercontent.com/551004/29770692-a20975c6-8bc6-11e7-8ab0-1cde275496e0.png)](https://play.google.com/store/apps/details?id=com.enatega.rider)
- [Rider App iOS](https://apps.apple.com/pk/app/enatega-rider-app/id1493291047) ## :book: Documentation <a id="heading-8"></a>
[![Rider App iOS](https://user-images.githubusercontent.com/551004/29770691-a2082ff4-8bc6-11e7-89a6-964cd405ea8e.png)](https://apps.apple.com/pk/app/enatega-rider-app/id1493291047)
- [Admin Dashboard](https://singlevendor-admin.enatega.com)
## Documentation and Product Demo Video:
Find the link for the complete documentation of the Enatega Single Vendor Solution [here](https://enatega.com/singlevendor-documentation/). Find the link for the complete documentation of the Enatega Single Vendor Solution [here](https://enatega.com/singlevendor-documentation/).
If you want to see demo video of the product please check out the link over [here](https://www.youtube.com/watch?v=AWbdt9GX1t4&t=3s&ab_channel=NinjasCode) ## :tv: Demo Videos: <a id="heading-14"></a>
| Demo |
| :---------------------------: |
| <a href="https://www.youtube.com/watch?v=AWbdt9GX1t4"><img src="https://img.youtube.com/vi/AWbdt9GX1t4/0.jpg" width="200" alt="Video"></a>
## Contributing: ## :people_holding_hands: Contributors: <a id="heading-14"></a>
<div align="center">
<br>
<a href="https://github.com/Ninjas-Code-official/Enatega-Food-Delivery-Solution/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Ninjas-Code-official/Enatega-Food-Delivery-Solution"" style="max-width: 50%; height: auto;" />
</a>
</div>
Enatega Restuarant Solution is an open source project. We welcome contributions of all kinds including documentation, bug fixes, feature requests, and code. Please read our [contributing guide](./contributingGuides/CONTRIBUTING.md) for more information on how you can contribute.
## Get the Latest News ## :warning: Disclaimer: <a id="heading-12"></a>
- [Facebook](https://www.facebook.com/enatega)
- [Twitter](https://twitter.com/EnategaA)
- [Instagram](https://www.instagram.com/enatega.nb/)
- [LinkedIn](https://www.linkedin.com/company/14583783/)
## Disclaimer:
The frontend source code for our solution is completely open source. However, the API and backend is proprietary and can be accessed via a paid license. For further information, contact us on the channels provided below. The frontend source code for our solution is completely open source. However, the API and backend is proprietary and can be accessed via a paid license. For further information, contact us on the channels provided below.
## Contact Us: ## :mailbox_with_mail: Contact Us: <a id="heading-13"></a>
sales@enatega.com sales@enatega.com