diff --git a/README.md b/README.md index 6217507..56fc56f 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ Enatega is a state of the art white label storefront delivery solution that allo
-## What is included: +## :question: What is included: 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: @@ -89,7 +89,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. -## Features: + +## :fire: Features: - Analytics dashboard for the mobile app - Payment integration with Paypal and Stripe @@ -104,7 +105,7 @@ Our solution contains three separate modules. These include the admin panel, the - Multiple variations of food items - Push notifications for both mobile and web -## Setup +## :repeat_one: Setup: As we’ve mentioned above, the solution includes three separate modules. To setup these modules, follow the steps below: @@ -116,7 +117,7 @@ The version of nodejs should be between 14.0 to 16.0 -[Link to Video tutorial/demonstration of Setup](https://enatega-1.gitbook.io/enatega-multivendor/configurations/google-maps-api-keys) -## Screenshots +## :framed_picture: Screenshots: | Customer Menu | Customer Categories | Customer Items | | :--------------------------------------------------: | :--------------------------------------------------: | :--------------------------------------------------: | @@ -130,7 +131,7 @@ The version of nodejs should be between 14.0 to 16.0 | :-----------------------------------------------: | :-----------------------------------------------: | :-----------------------------------------------: | | ![](./contributingGuides/screenshots/admin1.jpeg) | ![](./contributingGuides/screenshots/admin2.jpeg) | ![](./contributingGuides/screenshots/admin3.jpeg) | -## High Level Architecture +## :wrench: High Level Architecture: ![High Level Architecture](./contributingGuides/screenshots/HighArchitectDiagram.png) @@ -138,7 +139,7 @@ The version of nodejs should be between 14.0 to 16.0 - Web dashboard communicates with only API Server - Rider App communicates with API Server -### Prerequisites: +## :information_source: Prerequisites: ##### App Ids for Mobile App in app.json @@ -175,23 +176,21 @@ The version of nodejs should be between 14.0 to 16.0 ##### NOTE: Email provider has been only been tested for gmail accounts -## Technologies: +## :hammer_and_wrench: Technologies: +| Expo | React-Navigation | Apollo GraphQL | ReactJS | NodeJS | MongoDB | Firebase | +|:-------:|:------------:|:--------------:|:-------:|:------:|:-------:|:--------:| +| Enatega Logos| Enatega Logos| Enatega Logos| Enatega Logos | Enatega Logos | Enatega Logos | Enatega Logos | -- [Expo](https://expo.dev/) -- [React Navigation](https://reactnavigation.org/) -- [Apollo GraphQL](https://www.apollographql.com/) -- [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/) +|React Native | React Router | GraphQL | ExpressJS | React Strap | Amplitude | +|:------------:|:------------:|:-------:|:---------:|:-----------:|:---------:| +|Enatega Logos | Enatega Logos |Enatega Logos | Enatega Logos |Enatega Logos | Enatega Logos | + + +| Customer App | Rider App | Restaurant App | Customer Web | Admin Dashboard | +| :---------------------------: | :----------------------------: | :----------------------------:|:----------------------------:|:----------------------------:| +| Enatega Logos| Enatega Logos| Enatega Logos| Enatega Logos | Enatega Logos | +| Android Logo iOS Logo |Android Logo iOS Logo |Android Logo iOS Logo | -## Demos - [Customer App Android](https://play.google.com/store/apps/details?id=com.enatega.vendor) [![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) @@ -207,10 +206,11 @@ The version of nodejs should be between 14.0 to 16.0 - [Admin Dashboard](https://enatega.ninjascode.com/admin/dashboard) -## Documentation and Product Demo Video: +## :book: Documentation Find the link for the complete documentation of the Enatega Single Vendor Solution [here](https://ninjas-code.gitbook.io/enatega-full-app/). +## :tv: Demo Videos: 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) ## :people_holding_hands: Contributors: