diff --git a/docs/guides/admin/image-1.png b/docs/guides/admin/image-1.png new file mode 100644 index 0000000..86209f7 Binary files /dev/null and b/docs/guides/admin/image-1.png differ diff --git a/docs/guides/admin/image-10.png b/docs/guides/admin/image-10.png new file mode 100644 index 0000000..7008222 Binary files /dev/null and b/docs/guides/admin/image-10.png differ diff --git a/docs/guides/admin/image-11.png b/docs/guides/admin/image-11.png new file mode 100644 index 0000000..920acdd Binary files /dev/null and b/docs/guides/admin/image-11.png differ diff --git a/docs/guides/admin/image-12.png b/docs/guides/admin/image-12.png new file mode 100644 index 0000000..2008e1e Binary files /dev/null and b/docs/guides/admin/image-12.png differ diff --git a/docs/guides/admin/image-2.png b/docs/guides/admin/image-2.png new file mode 100644 index 0000000..9ac8bd8 Binary files /dev/null and b/docs/guides/admin/image-2.png differ diff --git a/docs/guides/admin/image-3.png b/docs/guides/admin/image-3.png new file mode 100644 index 0000000..ef5dc60 Binary files /dev/null and b/docs/guides/admin/image-3.png differ diff --git a/docs/guides/admin/image-4.png b/docs/guides/admin/image-4.png new file mode 100644 index 0000000..f7fa31a Binary files /dev/null and b/docs/guides/admin/image-4.png differ diff --git a/docs/guides/admin/image-5.png b/docs/guides/admin/image-5.png new file mode 100644 index 0000000..d00fd5e Binary files /dev/null and b/docs/guides/admin/image-5.png differ diff --git a/docs/guides/admin/image-6.png b/docs/guides/admin/image-6.png new file mode 100644 index 0000000..71021e3 Binary files /dev/null and b/docs/guides/admin/image-6.png differ diff --git a/docs/guides/admin/image-7.png b/docs/guides/admin/image-7.png new file mode 100644 index 0000000..bd11abc Binary files /dev/null and b/docs/guides/admin/image-7.png differ diff --git a/docs/guides/admin/image-8.png b/docs/guides/admin/image-8.png new file mode 100644 index 0000000..a589a83 Binary files /dev/null and b/docs/guides/admin/image-8.png differ diff --git a/docs/guides/admin/image-9.png b/docs/guides/admin/image-9.png new file mode 100644 index 0000000..943994b Binary files /dev/null and b/docs/guides/admin/image-9.png differ diff --git a/docs/guides/admin/image.png b/docs/guides/admin/image.png new file mode 100644 index 0000000..e40e908 Binary files /dev/null and b/docs/guides/admin/image.png differ diff --git a/docs/guides/admin/introduction.md b/docs/guides/admin/introduction.md index 08a0c5e..ba984f9 100644 --- a/docs/guides/admin/introduction.md +++ b/docs/guides/admin/introduction.md @@ -3,3 +3,89 @@ title: Introduction sidebar_position: 1 slug: /guides/admin/introduction --- + +## Admin Overview + +The admin console is where you configure the system wide settings such as 3rd party services, billing configurations, visibility controls etc. + +To access the system admin navigate to https://console.fleetbase.io/admin/ + +### Organisations + +View all of the organisations and users signed up to your Fleetbase instance. + +![Alt text](image.png) + +### Branding + +Upload your icon and logo for branding your Fleetbase instance. + +![Alt text](image-1.png) + +### Notifications + +Set up users to recieve system wide notifications. + +![Alt text](image-2.png) + +### 2FA Config + +Configure the 2FA functions for your Fleetbase instance. + +![Alt text](image-3.png) + +### Visibility Controls + +Select which FleetOps modules are visibile to the users of your Fleetbase instance. + +![Alt text](image-4.png) + +### Navigator App + +To use our existing published Navigator App with your Fleetbase instance, you need to create a instance linking URL. You can do so in the screenshot below. + +![Alt text](image-5.png) + +### Avatar Management + +Create an upload the avatars that you want users to use in your Fleetbase instance for vehicles, places and drivers. + +![Alt text](image-6.png) + +### Services + +Add in your API Keys for 3rd party services such as Google Maps, AWS, Twilio & Sentry in the Services section. + +![Alt text](image-7.png) + +### Mail Config + +Set up your mail server for sending emails from your Fleetbase instance. + +![Alt text](image-8.png) + +### Filestorage + +Set up your file storage configurations so users can upload files in your Fleetbase instance. + +![Alt text](image-9.png) + +### Queue Config + +Set up your queue service for your Fleetbase instance. + +![Alt text](image-10.png) + +### Socket Cluster + +Test socket connection. + +![Alt text](image-11.png) + +### Notification Channels + +Set up notifications system wide for your Fleetbase instance. + +![Alt text](image-12.png) + + diff --git a/docs/guides/developers-console/getting-started.md b/docs/guides/developers-console/getting-started.md deleted file mode 100644 index d681179..0000000 --- a/docs/guides/developers-console/getting-started.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Getting Started -sidebar_position: 1 -slug: /guides/console/getting-started ---- \ No newline at end of file diff --git a/docs/guides/developers-console/image-1.png b/docs/guides/developers-console/image-1.png new file mode 100644 index 0000000..82ee275 Binary files /dev/null and b/docs/guides/developers-console/image-1.png differ diff --git a/docs/guides/developers-console/image-2.png b/docs/guides/developers-console/image-2.png new file mode 100644 index 0000000..34ad863 Binary files /dev/null and b/docs/guides/developers-console/image-2.png differ diff --git a/docs/guides/developers-console/image-3.png b/docs/guides/developers-console/image-3.png new file mode 100644 index 0000000..e845859 Binary files /dev/null and b/docs/guides/developers-console/image-3.png differ diff --git a/docs/guides/developers-console/image-4.png b/docs/guides/developers-console/image-4.png new file mode 100644 index 0000000..88987eb Binary files /dev/null and b/docs/guides/developers-console/image-4.png differ diff --git a/docs/guides/developers-console/image-5.png b/docs/guides/developers-console/image-5.png new file mode 100644 index 0000000..bf02ed8 Binary files /dev/null and b/docs/guides/developers-console/image-5.png differ diff --git a/docs/guides/developers-console/image.png b/docs/guides/developers-console/image.png new file mode 100644 index 0000000..a3d1228 Binary files /dev/null and b/docs/guides/developers-console/image.png differ diff --git a/docs/guides/developers-console/introduction.md b/docs/guides/developers-console/introduction.md index 5cb2c0a..fb6b0ff 100644 --- a/docs/guides/developers-console/introduction.md +++ b/docs/guides/developers-console/introduction.md @@ -3,41 +3,31 @@ title: Introduction sidebar_position: 1 slug: /guides/console/introduction --- -## What is FleetOps? +## Overview -FleetOps is a dynamic last-mile operations and fleet management system. +The Developers console allows you to have an overview of your activity, and create the API Keys and Webhooks you need to integrate and run Fleetbase programatically. -### Dashboard +1. **Insights** - View API insights. -The Dashboard is your central place for operations. +![Alt text](image.png) -- View Drivers on Map -- Create Orders -- View Orders -- View Service Areas -- Create Service Areas -- Export Orders +2. **API Keys** - Create and view API Keys. -### Service Rates +![Alt text](image-1.png) -### Scheduler +3. **Webhooks** - Create and view webhook endpoints. -### Drivers +![Alt text](image-2.png) -### Vehicles +4. **WebSockets** - View your webhooks success and errors. -### Fleets +![Alt text](image-3.png) -### Vendors +5. **Logs** - View all of the logs for your account. -### Contacts +![Alt text](image-4.png) -### Places - -### Fuel Reports - -### Issues - -### Navigator App +6. **Events** - View all of the logs for your account. +![Alt text](image-5.png) diff --git a/docs/guides/fleet-ops/getting-started.md b/docs/guides/fleet-ops/getting-started.md index 8b4d30d..bc1a27a 100644 --- a/docs/guides/fleet-ops/getting-started.md +++ b/docs/guides/fleet-ops/getting-started.md @@ -2,4 +2,92 @@ title: Getting Started sidebar_position: 15 slug: /guides/fleet-ops/getting-started ---- \ No newline at end of file +--- + +## Get Started With FleetOps ## + +### 1. Sign Up ### + +‍The first step to revolutionizing your logistics operations is to sign up for Fleetbase. It's as simple as following this link and filling in a few details. + +![Alt text](image-51.png) + +### 2. Invite Users ### + +Invite your team members to join the platform, assign roles, and empower everyone to contribute to your fleet's success. + +![Alt text](image-52.png) + +### 3. Download Driver App ### + +‍Download the Fleetbase Navigator App on your iOS or Android device to take your fleet management wherever you go. + +Once you create a Driver within Fleetbase you can login to the Navigator App using the mobile you have assigned to that Driver. + +![Alt text](image-53.png) + +### 4. Configure Your Operations Flow ### + +Fleetbase can be fully customised to for your operations flow, whether your company conducts food delivery, garage pick up, courier services or logistics operations processes. + +Head to the Order Config within Fleetbase and follow the below step: + +1. Create New - Click 'New Order Config' and enter your operation flow details. ‍ + +2. Custom Fields - Create as many custom fields as you like, these fields will appear in the Order Form + +3. Activity Flow - Create custom activity flow statuses. These status are each activity point the driver either needs to update or gets updated automatically. +‍ +![Alt text](image-54.png) + +### 5. Create your Service Areas ### + +Define service areas and zones within Fleetbase to optimize your routes and streamline your deliveries. + +![Alt text](image-55.png) + +### 6. Set Up Custom Service Rates ### + +‍Our platform offers advanced algorithms to help you create custom service rates that reflect your business objectives. + +![Alt text](image-56.png) + +### 7. Invite Your Drivers ### + +‍Your drivers are the backbone of your fleet, and Fleetbase makes it easy to manage them efficiently. Add drivers to your fleet, track their assignments, and ensure seamless communication at all times. + +![Alt text](image-57.png) + +### 8. Equip Your Fleet ### + +‍From trucks to vans to bikes, add vehicles to your Fleetbase account in Fleets and keep track of their performance, maintenance schedules, and more. Your fleet, your rules! + +![Alt text](image-58.png) + +### 9. Keep Contacts & Customers Organized ### + +‍Managing contacts is a breeze with Fleetbase. Add clients, suppliers, and partners to your contact list and streamline communication for smooth order processing. + +![Alt text](image-59.png) + +### 10. Manage Delivery Locations ### + +‍Simplify your delivery logistics by adding places to your Fleetbase account. Whether it's a client's office or a warehouse, easily access and manage all your delivery locations in one place. + +![Alt text](image-60.png) + +### 11. Seamlessly Create Orders ### + +‍Ready to kickstart your operations? Create orders seamlessly within Fleetbase, specifying all the necessary details for smooth execution, from pickup to delivery. + +### 12. Stay Updated in Real-Time ### + +‍Keep track of your order's progress by updating its activity in real-time. From order acceptance to delivery confirmation, stay informed every step of the way. + +![Alt text](image-61.png) + +### 13. Close the Loop with POD ### + +‍Complete proof of delivery (POD) for your orders to finalize the transaction and ensure customer satisfaction. Capture essential information such as signatures and timestamps to confirm successful deliveries. + +![Alt text](image-62.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/image-51.png b/docs/guides/fleet-ops/image-51.png new file mode 100644 index 0000000..15092b2 Binary files /dev/null and b/docs/guides/fleet-ops/image-51.png differ diff --git a/docs/guides/fleet-ops/image-52.png b/docs/guides/fleet-ops/image-52.png new file mode 100644 index 0000000..ebb84f8 Binary files /dev/null and b/docs/guides/fleet-ops/image-52.png differ diff --git a/docs/guides/fleet-ops/image-53.png b/docs/guides/fleet-ops/image-53.png new file mode 100644 index 0000000..6bb3b7b Binary files /dev/null and b/docs/guides/fleet-ops/image-53.png differ diff --git a/docs/guides/fleet-ops/image-54.png b/docs/guides/fleet-ops/image-54.png new file mode 100644 index 0000000..5073fd1 Binary files /dev/null and b/docs/guides/fleet-ops/image-54.png differ diff --git a/docs/guides/fleet-ops/image-55.png b/docs/guides/fleet-ops/image-55.png new file mode 100644 index 0000000..c70e07b Binary files /dev/null and b/docs/guides/fleet-ops/image-55.png differ diff --git a/docs/guides/fleet-ops/image-56.png b/docs/guides/fleet-ops/image-56.png new file mode 100644 index 0000000..ee9ee0c Binary files /dev/null and b/docs/guides/fleet-ops/image-56.png differ diff --git a/docs/guides/fleet-ops/image-57.png b/docs/guides/fleet-ops/image-57.png new file mode 100644 index 0000000..23da811 Binary files /dev/null and b/docs/guides/fleet-ops/image-57.png differ diff --git a/docs/guides/fleet-ops/image-58.png b/docs/guides/fleet-ops/image-58.png new file mode 100644 index 0000000..4428b14 Binary files /dev/null and b/docs/guides/fleet-ops/image-58.png differ diff --git a/docs/guides/fleet-ops/image-59.png b/docs/guides/fleet-ops/image-59.png new file mode 100644 index 0000000..0fd9692 Binary files /dev/null and b/docs/guides/fleet-ops/image-59.png differ diff --git a/docs/guides/fleet-ops/image-60.png b/docs/guides/fleet-ops/image-60.png new file mode 100644 index 0000000..d868482 Binary files /dev/null and b/docs/guides/fleet-ops/image-60.png differ diff --git a/docs/guides/fleet-ops/image-61.png b/docs/guides/fleet-ops/image-61.png new file mode 100644 index 0000000..847f6ad Binary files /dev/null and b/docs/guides/fleet-ops/image-61.png differ diff --git a/docs/guides/fleet-ops/image-62.png b/docs/guides/fleet-ops/image-62.png new file mode 100644 index 0000000..7afb2f9 Binary files /dev/null and b/docs/guides/fleet-ops/image-62.png differ diff --git a/docs/guides/iam/image.png b/docs/guides/iam/image.png new file mode 100644 index 0000000..5f05cf0 Binary files /dev/null and b/docs/guides/iam/image.png differ diff --git a/docs/guides/iam/introduction.md b/docs/guides/iam/introduction.md index c46448b..dd29884 100644 --- a/docs/guides/iam/introduction.md +++ b/docs/guides/iam/introduction.md @@ -1,5 +1,23 @@ --- title: Introduction sidebar_position: 1 -slug: /guides/storefront/introduction +slug: /guides/iam/introduction --- +## Overview + +You can view all of your users, roles, groups and policies in the dashboard. + +### Users + +Add additional users to your organisation. You can then assign specific roles to these users or add them to groups. + +![Alt text](image.png) + +### Groups + +Add your existing users to groups to assign them to certain roles and policies. + +### Roles + +You can create specific roles which limit certain actions to Fleetbase features. Once you client New you can select which features are will be available for users or groups assigned to this role. + diff --git a/docs/guides/settings/_category_.json b/docs/guides/settings/_category_.json deleted file mode 100644 index ec5ea6c..0000000 --- a/docs/guides/settings/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Settings", - "position": 7, - "link": { - "type": "generated-index", - "description": "Getting Started with using Fleetbase" - } -} diff --git a/docs/guides/settings/introduction.md b/docs/guides/settings/introduction.md deleted file mode 100644 index c46448b..0000000 --- a/docs/guides/settings/introduction.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Introduction -sidebar_position: 1 -slug: /guides/storefront/introduction ---- diff --git a/docs/guides/storefront/customers.md b/docs/guides/storefront/customers.md new file mode 100644 index 0000000..54da7a0 --- /dev/null +++ b/docs/guides/storefront/customers.md @@ -0,0 +1,19 @@ +--- +title: Customers +sidebar_position: 1 +slug: /guides/storefront/customers +--- + +## Customers + +View all customers by clicking on the customers section under Resources + +### Create Customers + +You can create new customers 2 ways: + +1. Customers are automatically created when customers order through your Storefront App + +2. You can also create Customers manually by clicking ‘New’ on the top right + +![Alt text](image-6.png) \ No newline at end of file diff --git a/docs/guides/storefront/image-1.png b/docs/guides/storefront/image-1.png new file mode 100644 index 0000000..fd08af3 Binary files /dev/null and b/docs/guides/storefront/image-1.png differ diff --git a/docs/guides/storefront/image-10.png b/docs/guides/storefront/image-10.png new file mode 100644 index 0000000..091b4f6 Binary files /dev/null and b/docs/guides/storefront/image-10.png differ diff --git a/docs/guides/storefront/image-11.png b/docs/guides/storefront/image-11.png new file mode 100644 index 0000000..0690452 Binary files /dev/null and b/docs/guides/storefront/image-11.png differ diff --git a/docs/guides/storefront/image-12.png b/docs/guides/storefront/image-12.png new file mode 100644 index 0000000..8d2568b Binary files /dev/null and b/docs/guides/storefront/image-12.png differ diff --git a/docs/guides/storefront/image-2.png b/docs/guides/storefront/image-2.png new file mode 100644 index 0000000..9d08937 Binary files /dev/null and b/docs/guides/storefront/image-2.png differ diff --git a/docs/guides/storefront/image-3.png b/docs/guides/storefront/image-3.png new file mode 100644 index 0000000..9a8616d Binary files /dev/null and b/docs/guides/storefront/image-3.png differ diff --git a/docs/guides/storefront/image-4.png b/docs/guides/storefront/image-4.png new file mode 100644 index 0000000..62df6f7 Binary files /dev/null and b/docs/guides/storefront/image-4.png differ diff --git a/docs/guides/storefront/image-5.png b/docs/guides/storefront/image-5.png new file mode 100644 index 0000000..5485de0 Binary files /dev/null and b/docs/guides/storefront/image-5.png differ diff --git a/docs/guides/storefront/image-6.png b/docs/guides/storefront/image-6.png new file mode 100644 index 0000000..1a3c1eb Binary files /dev/null and b/docs/guides/storefront/image-6.png differ diff --git a/docs/guides/storefront/image-7.png b/docs/guides/storefront/image-7.png new file mode 100644 index 0000000..a27706d Binary files /dev/null and b/docs/guides/storefront/image-7.png differ diff --git a/docs/guides/storefront/image-8.png b/docs/guides/storefront/image-8.png new file mode 100644 index 0000000..5d542e3 Binary files /dev/null and b/docs/guides/storefront/image-8.png differ diff --git a/docs/guides/storefront/image-9.png b/docs/guides/storefront/image-9.png new file mode 100644 index 0000000..13eedbd Binary files /dev/null and b/docs/guides/storefront/image-9.png differ diff --git a/docs/guides/storefront/image.png b/docs/guides/storefront/image.png new file mode 100644 index 0000000..36d8c6e Binary files /dev/null and b/docs/guides/storefront/image.png differ diff --git a/docs/guides/storefront/introduction.md b/docs/guides/storefront/introduction.md index c46448b..6cdf1d5 100644 --- a/docs/guides/storefront/introduction.md +++ b/docs/guides/storefront/introduction.md @@ -3,3 +3,17 @@ title: Introduction sidebar_position: 1 slug: /guides/storefront/introduction --- + +## Overview + +Storefront is a headless e-commerce service which functions as an extension within Fleetbase + +Fleetbase Storefront provides several API-first approaches to products, carts, categories, customers, and checkout flow giving developers more control over the shopping experience. + +This project is to provide an open-sourced hyperlocal shopping app which can be fully customised and adapted to personal and commercial projects. + +This Storefront app is built with React Native to provide react native developers a head start building with Fleetbase and Storefront. + +The dashboard is where you can manage all of your orders, customers, stores and current earnings. + +![Alt text](image-8.png) \ No newline at end of file diff --git a/docs/guides/storefront/networks.md b/docs/guides/storefront/networks.md new file mode 100644 index 0000000..a148236 --- /dev/null +++ b/docs/guides/storefront/networks.md @@ -0,0 +1,64 @@ +--- +title: Networks +sidebar_position: 1 +slug: /guides/storefront/networks +--- + +## Networks + +Storefront allows you to quickly create marketplaces, enabling multiple storefronts to sell under an umbrella. When you create the network you define your rules and you're able to expand your network through invitations.. + +### Create Networks + +You can create new Network by clicking on the button on the top of the panel. + +1. **Name** - The name of the network. +2. **Description** - The description of the network. +2. **Currency** - The currency of the network. + +![Alt text](image.png) + +### Network Settings + +Configure the main settings of your network. + +![Alt text](image-1.png) + +1. **Name** - The name of your network. +2. **Description** - The description of the network. +2. **Tags** - Create tags for this Storefront to be selected on your app. +2. **Currency** - The currency of the network. +2. **Contact & Social** - Add contact details and social media accounts to be shown on your storefront app. +2. **Logo & Backdrop** - Add in a logo and your backdrop for your network. +2. **Images & Videos** - Add images & videos to your network. +2. **Alerts** - You can add users in your organisation to receive alerts for new orders that are placed on your Storefront App. +2. **Online** - Toggle if this network is online and available on your Storefront app. +2. **Enable Tax** - Toggle this to enable a tax percentage on this network orders. +2. **Auto Accept** - Toggle this to auto accept orders when placed by your customers on the Storefront App. +2. **Require Proof of Delivery** - Select whether proof of delivery is required on your network orders. Select the type of POD using the drop down. +2. **Enable Cash on Delivery** - Toggle for cash on delivery option for the orders in the network. +2. **Enable Order PickUp** - Toggle this for the option for your customers to collect orders from your network locations. +2. **Enable Tips** - Toggle for allowing tips on orders. +2. **Enable Delivery Tips** - Toggle for allowing tips for drivers on orders. +2. **Enable Multi-cart Checkout** - Toggle this to allow customers to order products / services from multiple vendors. +**Enable User Reviews** - Enable your customers to leave reviews on the individual Storefronts. + +### Stores ### + +You can invite and add multiple stores to your network. + +![Alt text](image-2.png) + + +### Orders ### + +View all of the orders that have been recieved from this network. + +![Alt text](image-3.png) + +### Customers ### + +View all of the customers that have been created from this orders in this network. + +![Alt text](image-4.png) + diff --git a/docs/guides/storefront/orders.md b/docs/guides/storefront/orders.md new file mode 100644 index 0000000..2b67402 --- /dev/null +++ b/docs/guides/storefront/orders.md @@ -0,0 +1,15 @@ +--- +title: Orders +sidebar_position: 1 +slug: /guides/storefront/orders +--- + +## Orders + +All of your orders that are generated form your Strorefront. + +### View Orders + +All of the orders that are generated by your customers from your Storefront App will be available to view, accept or reject from the orders section. + +![Alt text](image-5.png) \ No newline at end of file diff --git a/docs/guides/storefront/products.md b/docs/guides/storefront/products.md new file mode 100644 index 0000000..d3319ad --- /dev/null +++ b/docs/guides/storefront/products.md @@ -0,0 +1,43 @@ +--- +title: Products +sidebar_position: 1 +slug: /guides/storefront/products +--- + +## Products + +You can structure your storefront app with categories and products. + +These will be automatically displayed on your mobile app for your customers order or schedule your services. + +### Create Categories + +You can create categories to add your products or services to. + +1. **Create Order** - Click ‘Create Category’ from the Product section +2. **Enter Details** - Enter the details to create the category. + +![Alt text](image-7.png) + +### Create Products & Services + +Add products and services to be made available on your Storefront app by clicking ‘New’ inside the product category. + +**Details** - Add the specific details for the product or service. +**Product Name** - Name of the product. +**Product Description** - Description of the product. +**Product Tags** - Make tags on your storefront to group products to. +**Product SKU** - the SKU of the product. +**Price** - The price the customer will play for your product. +**Sale Price** - Add a sale price if the product is on sale. +**Metadata** - Add any metadata for this product. +**Translations** - Translate any product details by selecting a language from the dropdown menu. +**This is a Service** - Selecting this will show this product as a service on your Strorefront App. +**The Product is On Sale** - Selecting this will show that this product is on sale. +**This Product is Recommended** - Selecting this will show this product is recommended. +**This Product Is Available** - Selecting this will show that the product is available for purchase. +**Variants** - Adding new variants to products allow your customers to select variations of the product which suits their preference. +**Add-Ons** - Create pre set add ons for your customers to select from. +**Availability** - Set which times this product is available. +**Images** - Add images for this product. +**Youtube** - Add You tube links for this product. diff --git a/docs/guides/storefront/storefront-config.md b/docs/guides/storefront/storefront-config.md new file mode 100644 index 0000000..d548725 --- /dev/null +++ b/docs/guides/storefront/storefront-config.md @@ -0,0 +1,67 @@ +--- +title: Settings +sidebar_position: 1 +slug: /guides/storefront/config +--- + +## Settings + +The first thing to do in order to launch your Storefront app and so your customers can start purchasing your products or services is to create this storefronts main settings. + + +### General Settings + +The general settings are the backbone of your Store. + +![Alt text](image-9.png) + +1. **Name** - The name of your Store. +2. **Description** - The description of the Store. +2. **Tags** - Create tags for this Storefront to be selected on your app. +2. **Currency** - The currency of the store. +2. **Contact & Social** - Add contact details and social media accounts to be shown on your storefront app. +2. **Logo & Backdrop** - Add in a logo and your backdrop for your store. +2. **Images & Videos** - Add images & videos to your store. +2. **Alerts** - You can add users in your organisation to receive alerts for new orders that are placed on your Storefront App. +2. **Online** - Toggle if this store is online and available on your Storefront app. +2. **Enable Tax** - Toggle this to enable a tax percentage on this stores orders. +2. **Auto Accept** - Toggle this to auto accept orders when placed by your customers on the Storefront App. +2. **Require Proof of Delivery** - Select whether proof of delivery is required on your Storefront orders. Select the type of POD using the drop down. +2. **Enable Cash on Delivery** - Toggle for cash on delivery option for the orders in the store. +2. **Enable Order PickUp** - Toggle this for the option for your customers to collect orders from your Storefront locations. +2. **Enable Tips** - Toggle for allowing tips on orders. +2. **Enable Delivery Tips** - Toggle for allowing tips for drivers on orders. +2. **Enable Multi-cart Checkout** - Toggle this to allow customers to order products / services from multiple vendors. +**Enable User Reviews** - Enable your customers to leave reviews on the individual Storefronts. + + +### Locations ### + +Locations are the pick up location for the products or services that are purchased from this Storefront. + +![Alt text](image-10.png) + +1. **Create New Locations** - Add your Storefront locations for your customers to order from. +2. **Name** - Create the name of the location. +2. **Add Address** - dd the address of the location. +2. **Add Your Store Hours** - Once you have created the Store location, you can add the timings that the Store location is available. + +### Payment Gateway Settings ### + +You can add your own payment gateway specifically for orders which are executed for this Network. + +![Alt text](image-11.png) + +1. **Gateway Type** - Choose from the list of preset gateways or create your own. +2. **Gateway Name** - Create a gateway name. +2. **Gateway Code** - Create a code that is identifiable for the SDK. +2. **Callback URL** - Add a call back URL. +2. **Return URL** - Add a return URL. + +### Notification Channels ### + +Add your own Notification channel for example from Apple Push Notifications. + +![Alt text](image-12.png) + +