mirror of
https://github.com/fleetbase/fleetbase.git
synced 2025-12-19 22:27:22 +00:00
finished the system guides text and structure
This commit is contained in:
@@ -5,6 +5,9 @@ slug: /
|
||||
|
||||
# Overview
|
||||
|
||||
Explore our guides and examples to integrate & build with Fleetbase.
|
||||
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -2,9 +2,21 @@
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Developer Console Dashboard
|
||||
# 👩💻 Developer Console
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 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.
|
||||
|
||||
1. **API Requests** - View your API requests
|
||||
2. **API Error Distribution** - View your API errors and the distribution between GET, POST, PUT and DELETE
|
||||
3. **Webhooks** - View your webhooks success and errors
|
||||
4. **Webhooks** **Response Time** - View webhooks response times
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +32,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -2,9 +2,25 @@
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# API Keys
|
||||
# 🔑 API Keys
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 Generate API Keys to integrate and build with Fleetbase programatically.
|
||||
|
||||
Toggle ‘View Test Data’ to generate API keys in a test environment
|
||||
|
||||
Create API Key
|
||||
|
||||
1. **Name** - Add the name of the API Key
|
||||
2. **Expiration** - Set the date that this API expires
|
||||
3. **Allowed Browser Origins** - Input domains that will dictate the CORS policy for browser request from this API key
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +36,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -2,8 +2,23 @@
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Web Hooks
|
||||
# 🪝 Web Hooks
|
||||
|
||||
💡 You can create webhooks to simplify integration between applications and Fleetbase.
|
||||
|
||||
Create Webhooks
|
||||
|
||||
1. **Endpoint URL** - Enter the endpoint URL that Fleetbase will send callbacks to
|
||||
2. **Description** - An optional description of what this webhook endpoint is used for
|
||||
3. **API Credential** - Restrict the webhook endpoint to receive callbacks from a specific API key.
|
||||
4. **Version** - Select a specific API version to receive callbacks for
|
||||
5. **Events To Send** - Explicitly set which events to receive callbacks for
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
<!--
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
@@ -31,4 +46,4 @@ Congratulations, you have made your first post!
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). -->
|
||||
|
||||
@@ -2,9 +2,16 @@
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Logs
|
||||
# 🪵 Logs
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
💡 View all of the requests to and from your account.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
@@ -31,4 +38,4 @@ Congratulations, you have made your first post!
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). -->
|
||||
|
||||
@@ -2,9 +2,16 @@
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Events
|
||||
# 📺 Events
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
💡 View all of the events which happen in your account.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
@@ -54,4 +61,4 @@ module.exports = {
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
``` -->
|
||||
|
||||
@@ -2,9 +2,32 @@
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Access Management
|
||||
# 🧑🤝🧑 Access Management
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
### Dashboard
|
||||
|
||||
💡 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.
|
||||
|
||||
### 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.
|
||||
|
||||
### Policies
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io ✌️
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +43,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -2,9 +2,28 @@
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Dashboard
|
||||
# ⚙️ Dashboard
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 When you create an extension it can be used privately or distributed through Fleetbase Extensions.
|
||||
|
||||
This allows other users to install and use your extension.
|
||||
|
||||
Additionally you have the option to sell or create subscriptions you author.
|
||||
|
||||
There is nearly no limited to the type of extension you can develop for the Fleetbase Console.
|
||||
|
||||
Read our [docs](https://github.com/fleetbase) for more info.
|
||||
|
||||
### Install An Extension
|
||||
|
||||
Install extensions directly to use Fleetbase console by clicking the install button in each extension.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +39,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -1,10 +1,25 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Dashboard!
|
||||
# 💻 Dashboard
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 Storefront is a headless e-commerce service which functions as an extension within [Fleetbase](https://fleetbase.io/)
|
||||
|
||||
[Fleetbase Storefront](https://fleetbase.io/products/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](https://reactnative.dev/) 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.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +35,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -2,9 +2,46 @@
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Products
|
||||
# 🛒 Products
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 You can structure your customer 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**
|
||||
1. Click ‘Create Category’ from the Product section
|
||||
2. **Enter Details** - Enter the details to create the category.
|
||||
|
||||
### Add Products / Services
|
||||
|
||||
Add products and services to be made available on your Storefront app by clicking ‘New’ inside the product category.
|
||||
|
||||
1. **Details** - Add the specific details for the product or service
|
||||
1. **Product Name**
|
||||
2. **Product Description**
|
||||
3. **Product Tags** - Make tags on your storefront to group products to
|
||||
4. **Product SKU**
|
||||
5. **Price** - The price the customer will play for your product
|
||||
6. **Sale Price** - Add a sale price if the product is on sale
|
||||
7. **Metadata** - Add any metadata for this product
|
||||
8. **Translations** - Translate any product details by selecting a language from the dropdown menu
|
||||
9. Checkboxes
|
||||
1. This is a service - Selecting this will show this product as a service on your Strorefront App
|
||||
2. The product is on sale - Selecting this will show that this product is on sale
|
||||
3. This product is recommended - Selecting this will show this product is recommended
|
||||
4. This product is available - Selecting this will show that the product is available for purchase
|
||||
10. Variants
|
||||
1. Adding new variants to products allow your customers to select variations of the product which suits their preference
|
||||
11. Add-Ons - Create pre set add ons for your customers to select from
|
||||
12. Availability - Set which times this product is available
|
||||
13. Images - Add images for this product
|
||||
14. Youtube - Add You tube links for this product
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +57,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -2,9 +2,39 @@
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Customers
|
||||
# 👥 Customers
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
💡 You can view all of your Storefront customers in this section
|
||||
|
||||
### View Customers
|
||||
|
||||
View all customers by clicking on the customers section under Resources
|
||||
|
||||
### Create Customer
|
||||
|
||||
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
|
||||
|
||||
1. **Create New Customer** - Enter the details to create the customer.
|
||||
1. **Name**
|
||||
2. Title
|
||||
3. **Internal ID** - You can set your own internal ID for this customer
|
||||
4. **Email**
|
||||
5. **Phone**
|
||||
6. **Type** - Select between your contact or customer for easy filtering
|
||||
|
||||
### Export Customers
|
||||
|
||||
You can export your customers in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
@@ -31,4 +61,4 @@ Congratulations, you have made your first post!
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). -->
|
||||
|
||||
@@ -2,10 +2,23 @@
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
Update the status of the order through the dashboard.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
<!--
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
@@ -31,4 +44,4 @@ Congratulations, you have made your first post!
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). -->
|
||||
|
||||
@@ -2,7 +2,59 @@
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Multi Vendor Network
|
||||
# 🏪 Multi Vendor Network
|
||||
|
||||
💡 You can separate your Storefront App to include multiple vendors in different categories. Invite your network to your Storefront, they can add their own products and service and make them available.
|
||||
|
||||
### View Networks
|
||||
|
||||
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.
|
||||
|
||||
### Create Networks
|
||||
|
||||
You can create new Network by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create Network** - You can create an order a few ways:
|
||||
1. **Network Name** - The name of the network
|
||||
2. **Network Descriptions** - The description of the network
|
||||
3. **Network Currency** - The currency of the network
|
||||
2. **Enter Details** - Once you have created the network you can start adding or inviting vendors. Click Manage Network.
|
||||
|
||||
1. General Network Settings
|
||||
1. **Name** - The name of the Network
|
||||
2. **Description** - The description of the network
|
||||
3. **Currency** - The currency of the network
|
||||
4. **Contact & Social** - Add contact details and social media accounts to be shown on your storefront app.
|
||||
5. **Logo & Backdrop** - Add in a logo and your backdrop for your network
|
||||
6. **Alerts** - you can add users in your organisation to receive alerts for new orders that are placed on your Storefront App
|
||||
7. **Online** - Toggle if this network is online and available on your Storefront app
|
||||
8. **Enable Tax** - Toggle this to enable a tax percentage on this Networks orders
|
||||
9. **Auto Accept** - Toggle this to auto accept orders when placed by your customers on the Storefront App
|
||||
10. **Require Proof of Delivery** - Select whether proof of delivery is required on your Storefront orders. Select the type of POD using the drop down
|
||||
11. **Enable Cash on Delivery** - Toggle for cash on delivery option for the orders in the Network
|
||||
12. **Enable Order PickUp** - Toggle this for the option for your customers to collect orders from your Storefront locations.
|
||||
13. **Enable Tips** - Toggle for allowing tips on orders
|
||||
14. **Enable Delivery Tips** - Toggle for allowing tips for drivers on orders
|
||||
15. **Enable Multi-cart Checkout** - Toggle this to allow customers to order products / services from multiple vendors
|
||||
16. **Enable User Reviews** - Enable your customers to leave reviews on the individual Storefronts.
|
||||
17. **API Settings**
|
||||
1. Generate your Network key for this Networks API
|
||||
18. **Payment Gateway**
|
||||
1. You can add your own payment gateway specifically for orders which are executed for this Network
|
||||
19. **Notification Channels**
|
||||
1. Configure notification channels for your Storefront. Each notification channel additionally can have its own rules and options.
|
||||
2. **Stores** - Create your Network categories, invite other store vendors to create their own storefronts and create your own stores to add to the network
|
||||
|
||||
1. **Add Category** - Create categories for your Stores in the Network
|
||||
2. **Invite Stores** - Invite 3rd party vendors to your network. They will have their own Storefront access where they can add their own products and services to their Storefront. This will be made available to your customers on your Storefront apps.
|
||||
3. **Add Stores** - Add your own Stores that you create directly to your network.
|
||||
3. **Orders** - View all of the orders that are created from this specific network.
|
||||
4. **Customers** - View all of the customers that are created from this specific network.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
|
||||
@@ -20,7 +72,7 @@ Create a Markdown file at `docs/hello.md`:
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
|
||||
<!-- A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
|
||||
|
||||
## Configure the Sidebar
|
||||
|
||||
@@ -54,4 +106,4 @@ module.exports = {
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
``` -->
|
||||
|
||||
@@ -1,9 +1,89 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Storefront Settings
|
||||
# ⚙️ Storefront 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
|
||||
|
||||
1. General Network Settings
|
||||
1. **Name** - The name of the Network
|
||||
2. **Description** - The description of the network
|
||||
3. **Tags** - Create tags for this Storefront to be selected on your app
|
||||
4. **Currency** - The currency of the network
|
||||
5. **Contact & Social** - Add contact details and social media accounts to be shown on your storefront app.
|
||||
6. **Logo & Backdrop** - Add in a logo and your backdrop for your network
|
||||
7. **Images & Videos** - Add images & videos to your Storefront
|
||||
8. **Alerts** - you can add users in your organisation to receive alerts for new orders that are placed on your Storefront App
|
||||
9. **Online** - Toggle if this network is online and available on your Storefront app
|
||||
10. **Enable Tax** - Toggle this to enable a tax percentage on this Networks orders
|
||||
11. **Auto Accept** - Toggle this to auto accept orders when placed by your customers on the Storefront App
|
||||
12. **Require Proof of Delivery** - Select whether proof of delivery is required on your Storefront orders. Select the type of POD using the drop down
|
||||
13. **Enable Cash on Delivery** - Toggle for cash on delivery option for the orders in the Network
|
||||
14. **Enable Order PickUp** - Toggle this for the option for your customers to collect orders from your Storefront locations.
|
||||
15. **Enable Tips** - Toggle for allowing tips on orders
|
||||
16. **Enable Delivery Tips** - Toggle for allowing tips for drivers on orders
|
||||
17. **Enable Multi-cart Checkout** - Toggle this to allow customers to order products / services from multiple vendors
|
||||
18. **Enable User Reviews** - Enable your customers to leave reviews on the individual Storefronts.
|
||||
|
||||
### Locations
|
||||
|
||||
1. **Create New Locations** - Add your Storefront locations for your customers to order from.
|
||||
|
||||
1. **Name** - Create the name of the location
|
||||
2. **Add Address** - Add the address of the location
|
||||
3. **Add Your Store Hours** - Once you have created the Store location, you can add the timings that the Store location is available
|
||||
|
||||
### General Settings
|
||||
|
||||
1. General Network Settings
|
||||
1. **Name** - The name of the Network
|
||||
2. **Description** - The description of the network
|
||||
3. **Tags** - Create tags for this Storefront to be selected on your app
|
||||
4. **Currency** - The currency of the network
|
||||
5. **Contact & Social** - Add contact details and social media accounts to be shown on your storefront app.
|
||||
6. **Logo & Backdrop** - Add in a logo and your backdrop for your network
|
||||
7. **Images & Videos** - Add images & videos to your Storefront
|
||||
8. **Alerts** - you can add users in your organisation to receive alerts for new orders that are placed on your Storefront App
|
||||
9. **Online** - Toggle if this network is online and available on your Storefront app
|
||||
10. **Enable Tax** - Toggle this to enable a tax percentage on this Networks orders
|
||||
11. **Auto Accept** - Toggle this to auto accept orders when placed by your customers on the Storefront App
|
||||
12. **Require Proof of Delivery** - Select whether proof of delivery is required on your Storefront orders. Select the type of POD using the drop down
|
||||
13. **Enable Cash on Delivery** - Toggle for cash on delivery option for the orders in the Network
|
||||
14. **Enable Order PickUp** - Toggle this for the option for your customers to collect orders from your Storefront locations.
|
||||
15. **Enable Tips** - Toggle for allowing tips on orders
|
||||
16. **Enable Delivery Tips** - Toggle for allowing tips for drivers on orders
|
||||
17. **Enable Multi-cart Checkout** - Toggle this to allow customers to order products / services from multiple vendors
|
||||
18. **Enable User Reviews** - Enable your customers to leave reviews on the individual Storefronts.
|
||||
|
||||
### Payment Gateway Settings
|
||||
|
||||
You can add your own payment gateway specifically for orders which are executed for this Network.
|
||||
|
||||
1. **Gateway Type** - Choose from the list of preset gateways or create your own
|
||||
2. **Gateway Name** - Create a gateway name
|
||||
3. **Gateway Code** - Create a code that is identifiable for the SDK
|
||||
4. **Callback URL** - Add a call back URL
|
||||
5. **Return URL** - Add a return URL
|
||||
6. **Config**
|
||||
1. Add your secret key
|
||||
2. Add your publishable key
|
||||
|
||||
### API Keys
|
||||
|
||||
Copy your API key for this Storefront
|
||||
|
||||
### Notification Channels
|
||||
|
||||
Add your own Notification channel for example from Apple Push Notifications
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
<!--
|
||||
Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
@@ -53,5 +133,5 @@ module.exports = {
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
};
|
||||
}; -->
|
||||
```
|
||||
|
||||
@@ -1,10 +1,17 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Publish Your App
|
||||
# 📱 Publish Your App
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
💡 Once you have created your Storefront you can visit out Github to follow steps to launch your application. Alternatively you can contact us and we can assist with this.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
- `src/pages/index.js` → `localhost:3000/`
|
||||
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||
@@ -40,4 +47,4 @@ Create a file at `src/pages/my-markdown-page.md`:
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). -->
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Markdown Features
|
||||
@@ -71,7 +71,7 @@ Markdown code blocks are supported with Syntax highlighting.
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
|
||||
@@ -129,20 +129,21 @@ This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
```
|
||||
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
export const Highlight = ({ children, color }) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "FleetOps",
|
||||
"label": "Overview",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Dashboard!
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
||||
|
||||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
||||
|
||||
## What's next?
|
||||
|
||||
- Read the [official documentation](https://docusaurus.io/)
|
||||
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
|
||||
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
@@ -1,10 +1,61 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Dashboard!
|
||||
# 📖 Quick Start Guide
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 Getting started with Fleetbase is easy. We have made managing your logistics operation simple and have outlines a few steps you can do to get up and running in a flash.
|
||||
|
||||
# Onboarding Steps
|
||||
|
||||
We have created a step by step to do list so you can get started using or testing FleetOps.
|
||||
|
||||
Follow the steps to start managing logistics operations.
|
||||
|
||||
---
|
||||
|
||||
### Create Users
|
||||
|
||||
- [ ] Navigate to the [IAM section](https://www.notion.so/Access-Management-1ec1bf759db943d1a269b5ee85848d90) to start creating logins and groups for your internal team.
|
||||
|
||||
### Add Drivers
|
||||
|
||||
- [ ] First thing is to add your drivers to Fleetbase - Navigate to the [Drivers](https://www.notion.so/Drivers-a782be160e1641bebf269ca00e8adc18) section to learn more.
|
||||
|
||||
### Add Vehicles
|
||||
|
||||
- [ ] Next add your vehicles to Fleetbase - Navigate to the [Vehicles](https://www.notion.so/Vehicles-3b84b044db83476d8741e1dff105f062) section to learn more.
|
||||
|
||||
### Add Contacts
|
||||
|
||||
- [ ] Next add your contacts & customers to Fleetbase - Navigate to the [Contacts](https://www.notion.so/Contacts-0a4092ea3fcb4630b16391bc10beefc8) section to learn more.
|
||||
|
||||
### Add Vendors
|
||||
|
||||
- [ ] Next add your vendors and 3rd party contractors to Fleetbase - Navigate to the [Vendors](https://www.notion.so/Vendors-cbe79ced62a9487d9b689e19215cb00c) section to learn more.
|
||||
|
||||
### Download Navigator Driver Apps
|
||||
|
||||
- [ ] In order to assign orders to your drivers to complete they need to download the Fleetbase Navigator Driver App. You can download it on [IOS](https://apps.apple.com/us/app/fleetbase-navigator/id1554208255) or [Android](https://play.google.com/store/apps/details?id=com.fleetbase.navigator&hl=en_GB&gl=US&pli=1).
|
||||
|
||||
### Add or Create Your Custom Order Flows
|
||||
|
||||
- [ ] In order to match your current operational process you can do so by creating your custom order flows. Install the preset order flows from the Extensions module or create them yourself using the [Order Config](https://www.notion.so/Orders-db5462c2194b4ce1b717b56487c16a30).
|
||||
|
||||
### Set Your Service Rates
|
||||
|
||||
- [ ] Before you create your first order in FleetOps, you should create the service rates you require to be applied to your orders. Visit the [Service Rates](https://www.notion.so/Service-Rates-a2e5adac9d5f4192b5a7cbfbd71add04) section to learn how to do it.
|
||||
|
||||
### Create & Complete Your First Order
|
||||
|
||||
- [ ] Once you have added your resources and set your order configuration in the steps above you can create your first order. Learn more using the [Order Wiki](https://www.notion.so/Orders-db5462c2194b4ce1b717b56487c16a30).
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io ✌️
|
||||
|
||||
<!-- You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
@@ -20,4 +71,4 @@ Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) -->
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 👥 Contacts
|
||||
|
||||
💡 Contacts can be assigned when creating an order or created automatically through your storefront application.
|
||||
|
||||
### View Contacts
|
||||
|
||||
View all contacts by clicking on the contacts section under Resources
|
||||
|
||||
### Create Contact
|
||||
|
||||
You can create new contact by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create New Contact** - Enter the details to create the driver.
|
||||
1. **Name**
|
||||
2. **Internal ID** - You can set your own internal ID for this driver
|
||||
3. **Email**
|
||||
4. **Phone**
|
||||
5. **Type** - Select between your contact or customer for easy filtering
|
||||
|
||||
### Export Drivers
|
||||
|
||||
You can export your contacts in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- ### View Orders
|
||||
|
||||
You can view all of your orders in 2 views.
|
||||
|
||||
1. **Map View** - This is a view of all of your current operations, you can view and manage live and historic orders.
|
||||
2. **Table View** - A table view of all your orders.
|
||||
|
||||
### Create Orders
|
||||
|
||||
You can create new orders by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create Order** - You can create an order a few ways:
|
||||
1. Manually enter the order details
|
||||
2. Click ‘Import’ to bulk import orders using our excel template
|
||||
3. Create orders directions through our API - view our API Documentation here.
|
||||
|
||||
2. **Enter Details** - Enter the details to create the order.
|
||||
|
||||
1. **Order Type** - Select the order type for this delivery or service. You can add more in the via the **Extensions** module
|
||||
2. **Internal ID** - Add an internal ID for the order.
|
||||
3. **Schedule** - Schedule this order for a specific date or time. You can view scheduled orders in the **Scheduler**.
|
||||
4. **Customers** - Select a customer from your Contacts list.
|
||||
5. **Facilitator** - Select a facilitator for the job, this can be a 3rd party vendor or subcontractor that will be carrying out the transportation order.
|
||||
6. **Assign Driver** - Assign a driver to assign and complete this order.
|
||||
7. **Ad-hoc** - Toggling Ad-hoc will enable the order to intelligently ping drivers within the order pickup vicinity about the order allowing the first available driver to accept the order. This is an alternative to manually assigning the driver for real-time orders.
|
||||
8. **Dispatch Immediately** - Immediately dispatch the order to the assigned driver.
|
||||
9. **Require Proof of Delivery** - Toggling this will require the order to have a proof of delivery.
|
||||
10. **Metadata** - Add in any additional fields you require for this order.
|
||||
11. **Route** - Add the pick up and drop off for the order. This will be automatically added if the order was created programmatically or through a bulk upload. If you toggle Multiple Dropoff’s you can choose to Optimise the Route.
|
||||
12. **Payload / Entities** - Add specific payload items for the order, this will be done automatically through bulk upload or the API.
|
||||
13. **Service** - Select a defined Service Rate to generate real time service quotations to apply this order.
|
||||
|
||||
### Custom Order Flows
|
||||
|
||||
You can create custom order flows which fit your operational process through the ‘Config’ section.
|
||||
|
||||
1. **Install** order flows from the Extensions module or create your own,
|
||||
2. **Details** - Add the specific details for this order flow.
|
||||
3. **Custom Fields** - Add custom fields for this order flow.
|
||||
4. **Activity Fields** - Activity flow configuration will allow you to define the different types of tracking status activities that apply for this order type. Logic of the activity flow can be configured.
|
||||
5. **Entities** - Entities configuration will allow you to define the different type of entities that should be selectable for this order type. These should be used like templates to make manual order creation faster.
|
||||
|
||||
### Updating Orders
|
||||
|
||||
Each order that has been created will have a series of activity status updates that need to be actioned before the order is completed.
|
||||
|
||||
The activities that are available for completion will be the same as the order configuration selected. There are two ways to update the status of a job to completion.
|
||||
|
||||
Update the order till the completed or last status.
|
||||
|
||||
1. You can update the status of the job by viewing the job on the FleetOps web app, see screenshot below:
|
||||
2. The driver can update from the Fleetbase Navigator App.
|
||||
|
||||
### Completed Orders
|
||||
|
||||
Once the order has been you can view the activity time stamps and the order details on the order details
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
|
||||
```md title="blog/2021-02-28-greetings.md"
|
||||
---
|
||||
slug: greetings
|
||||
title: Greetings!
|
||||
authors:
|
||||
- name: Joel Marcey
|
||||
title: Co-creator of Docusaurus 1
|
||||
url: https://github.com/JoelMarcey
|
||||
image_url: https://github.com/JoelMarcey.png
|
||||
- name: Sébastien Lorber
|
||||
title: Docusaurus maintainer
|
||||
url: https://sebastienlorber.com
|
||||
image_url: https://github.com/slorber.png
|
||||
tags: [greetings]
|
||||
---
|
||||
|
||||
Congratulations, you have made your first post!
|
||||
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). --> -->
|
||||
@@ -0,0 +1,120 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 📍 Places
|
||||
|
||||
💡 Places can be created to schedule orders to. They are also automatically created if done through new orders and also through Storefront orders being created.
|
||||
|
||||
### View Places
|
||||
|
||||
View all places by clicking on the places section under Resources
|
||||
Contacts can be assigned when creating an order or created automatically through your storefront application.
|
||||
|
||||
### Create Place
|
||||
|
||||
You can create new place by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create New Contact** - Enter the details to create the driver.
|
||||
1. **Name**
|
||||
2. **Street** - Once you start to input the address in this field, the address will be auto populated.
|
||||
|
||||
### Export Places
|
||||
|
||||
You can export your places in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- ### View Orders
|
||||
|
||||
You can view all of your orders in 2 views.
|
||||
|
||||
1. **Map View** - This is a view of all of your current operations, you can view and manage live and historic orders.
|
||||
2. **Table View** - A table view of all your orders.
|
||||
|
||||
### Create Orders
|
||||
|
||||
You can create new orders by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create Order** - You can create an order a few ways:
|
||||
1. Manually enter the order details
|
||||
2. Click ‘Import’ to bulk import orders using our excel template
|
||||
3. Create orders directions through our API - view our API Documentation here.
|
||||
|
||||
2. **Enter Details** - Enter the details to create the order.
|
||||
|
||||
1. **Order Type** - Select the order type for this delivery or service. You can add more in the via the **Extensions** module
|
||||
2. **Internal ID** - Add an internal ID for the order.
|
||||
3. **Schedule** - Schedule this order for a specific date or time. You can view scheduled orders in the **Scheduler**.
|
||||
4. **Customers** - Select a customer from your Contacts list.
|
||||
5. **Facilitator** - Select a facilitator for the job, this can be a 3rd party vendor or subcontractor that will be carrying out the transportation order.
|
||||
6. **Assign Driver** - Assign a driver to assign and complete this order.
|
||||
7. **Ad-hoc** - Toggling Ad-hoc will enable the order to intelligently ping drivers within the order pickup vicinity about the order allowing the first available driver to accept the order. This is an alternative to manually assigning the driver for real-time orders.
|
||||
8. **Dispatch Immediately** - Immediately dispatch the order to the assigned driver.
|
||||
9. **Require Proof of Delivery** - Toggling this will require the order to have a proof of delivery.
|
||||
10. **Metadata** - Add in any additional fields you require for this order.
|
||||
11. **Route** - Add the pick up and drop off for the order. This will be automatically added if the order was created programmatically or through a bulk upload. If you toggle Multiple Dropoff’s you can choose to Optimise the Route.
|
||||
12. **Payload / Entities** - Add specific payload items for the order, this will be done automatically through bulk upload or the API.
|
||||
13. **Service** - Select a defined Service Rate to generate real time service quotations to apply this order.
|
||||
|
||||
### Custom Order Flows
|
||||
|
||||
You can create custom order flows which fit your operational process through the ‘Config’ section.
|
||||
|
||||
1. **Install** order flows from the Extensions module or create your own,
|
||||
2. **Details** - Add the specific details for this order flow.
|
||||
3. **Custom Fields** - Add custom fields for this order flow.
|
||||
4. **Activity Fields** - Activity flow configuration will allow you to define the different types of tracking status activities that apply for this order type. Logic of the activity flow can be configured.
|
||||
5. **Entities** - Entities configuration will allow you to define the different type of entities that should be selectable for this order type. These should be used like templates to make manual order creation faster.
|
||||
|
||||
### Updating Orders
|
||||
|
||||
Each order that has been created will have a series of activity status updates that need to be actioned before the order is completed.
|
||||
|
||||
The activities that are available for completion will be the same as the order configuration selected. There are two ways to update the status of a job to completion.
|
||||
|
||||
Update the order till the completed or last status.
|
||||
|
||||
1. You can update the status of the job by viewing the job on the FleetOps web app, see screenshot below:
|
||||
2. The driver can update from the Fleetbase Navigator App.
|
||||
|
||||
### Completed Orders
|
||||
|
||||
Once the order has been you can view the activity time stamps and the order details on the order details
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
|
||||
```md title="blog/2021-02-28-greetings.md"
|
||||
---
|
||||
slug: greetings
|
||||
title: Greetings!
|
||||
authors:
|
||||
- name: Joel Marcey
|
||||
title: Co-creator of Docusaurus 1
|
||||
url: https://github.com/JoelMarcey
|
||||
image_url: https://github.com/JoelMarcey.png
|
||||
- name: Sébastien Lorber
|
||||
title: Docusaurus maintainer
|
||||
url: https://sebastienlorber.com
|
||||
image_url: https://github.com/slorber.png
|
||||
tags: [greetings]
|
||||
---
|
||||
|
||||
Congratulations, you have made your first post!
|
||||
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). --> -->
|
||||
@@ -2,9 +2,71 @@
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Orders
|
||||
# 💵 Orders
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
### View Orders
|
||||
|
||||
💡 You can view all of your orders in 2 views.
|
||||
|
||||
1. **Map View** - This is a view of all of your current operations, you can view and manage live and historic orders.
|
||||
2. **Table View** - A table view of all your orders.
|
||||
|
||||
### Create Orders
|
||||
|
||||
You can create new orders by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create Order** - You can create an order a few ways:
|
||||
1. Manually enter the order details
|
||||
2. Click ‘Import’ to bulk import orders using our excel template
|
||||
3. Create orders directions through our API - view our API Documentation here.
|
||||
|
||||
2. **Enter Details** - Enter the details to create the order.
|
||||
|
||||
1. **Order Type** - Select the order type for this delivery or service. You can add more in the via the **Extensions** module
|
||||
2. **Internal ID** - Add an internal ID for the order.
|
||||
3. **Schedule** - Schedule this order for a specific date or time. You can view scheduled orders in the **Scheduler**.
|
||||
4. **Customers** - Select a customer from your Contacts list.
|
||||
5. **Facilitator** - Select a facilitator for the job, this can be a 3rd party vendor or subcontractor that will be carrying out the transportation order.
|
||||
6. **Assign Driver** - Assign a driver to assign and complete this order.
|
||||
7. **Ad-hoc** - Toggling Ad-hoc will enable the order to intelligently ping drivers within the order pickup vicinity about the order allowing the first available driver to accept the order. This is an alternative to manually assigning the driver for real-time orders.
|
||||
8. **Dispatch Immediately** - Immediately dispatch the order to the assigned driver.
|
||||
9. **Require Proof of Delivery** - Toggling this will require the order to have a proof of delivery.
|
||||
10. **Metadata** - Add in any additional fields you require for this order.
|
||||
11. **Route** - Add the pick up and drop off for the order. This will be automatically added if the order was created programmatically or through a bulk upload. If you toggle Multiple Dropoff’s you can choose to Optimise the Route.
|
||||
12. **Payload / Entities** - Add specific payload items for the order, this will be done automatically through bulk upload or the API.
|
||||
13. **Service** - Select a defined Service Rate to generate real time service quotations to apply this order.
|
||||
|
||||
### Custom Order Flows
|
||||
|
||||
You can create custom order flows which fit your operational process through the ‘Config’ section.
|
||||
|
||||
1. **Install** order flows from the Extensions module or create your own,
|
||||
2. **Details** - Add the specific details for this order flow.
|
||||
3. **Custom Fields** - Add custom fields for this order flow.
|
||||
4. **Activity Fields** - Activity flow configuration will allow you to define the different types of tracking status activities that apply for this order type. Logic of the activity flow can be configured.
|
||||
5. **Entities** - Entities configuration will allow you to define the different type of entities that should be selectable for this order type. These should be used like templates to make manual order creation faster.
|
||||
|
||||
### Updating Orders
|
||||
|
||||
Each order that has been created will have a series of activity status updates that need to be actioned before the order is completed.
|
||||
|
||||
The activities that are available for completion will be the same as the order configuration selected. There are two ways to update the status of a job to completion.
|
||||
|
||||
Update the order till the completed or last status.
|
||||
|
||||
1. You can update the status of the job by viewing the job on the FleetOps web app, see screenshot below:
|
||||
2. The driver can update from the Fleetbase Navigator App.
|
||||
|
||||
### Completed Orders
|
||||
|
||||
Once the order has been you can view the activity time stamps and the order details on the order details
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
@@ -31,4 +93,4 @@ Congratulations, you have made your first post!
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). -->
|
||||
|
||||
@@ -2,9 +2,22 @@
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Service Areas
|
||||
# 🌎 Service Areas
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
### View Service Areas
|
||||
|
||||
💡 Service areas can be created to assign certain fleets, vehicles and drivers too. They can also be used to create specific service rates which can be assigned to orders.
|
||||
|
||||
### Create Service Area
|
||||
|
||||
You can create service rates and use the tools on the right hand side to draw your service area boundaries.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
@@ -31,4 +44,4 @@ Congratulations, you have made your first post!
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). -->
|
||||
|
||||
@@ -2,9 +2,16 @@
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Scheduler
|
||||
# 📅 Scheduler
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
💡 The scheduler is where you can view all of your orders that are pending for dispatch and schedule the time and place.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
@@ -53,5 +60,5 @@ module.exports = {
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
};
|
||||
}; -->
|
||||
```
|
||||
|
||||
@@ -2,9 +2,33 @@
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Service Rates
|
||||
# 💰 Service Rates
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
💡 You can create custom service rates to assign to orders.
|
||||
|
||||
### Create Service Rate
|
||||
|
||||
You can create new service rates by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create Service Rate**
|
||||
1. **Service Name** - The display name for this service
|
||||
2. **Service Order Type** - Restrict this specific service to an order type
|
||||
3. **Base Fee** - Set a standard fee for this particular service
|
||||
4. **Rate Calculation Method** - This will be the process for calculating the rate when queried
|
||||
1. Fixed Meter
|
||||
2. Per Meter
|
||||
3. Per - Drop-Off
|
||||
4. Algorithm
|
||||
5. **Cash On Delivery** - You can add an additional fee for ‘cash on delivery orders’
|
||||
6. **Peak Hours** - You can add an additional fee for ‘peak hours’
|
||||
7. **Restrict Service** - You can restrict this service rate to any service areas that have been created previously
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
@@ -54,4 +78,4 @@ module.exports = {
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
``` -->
|
||||
|
||||
@@ -2,7 +2,40 @@
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Drivers
|
||||
# 🧍Drivers
|
||||
|
||||
💡 Drivers can be used to assign new orders, vehicles and fleets to.
|
||||
|
||||
### View Drivers
|
||||
|
||||
View all drivers by clicking on the driver section under Resources
|
||||
|
||||
### Create Driver
|
||||
|
||||
You can create new orders by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create New Driver** - Enter the details to create the driver.
|
||||
1. **Name**
|
||||
2. **Internal ID** - You can set your own internal ID for this driver
|
||||
3. **Drivers License**
|
||||
4. **Email**
|
||||
5. **Phone**
|
||||
6. **Vendor** - Select a vendor or facilitator that this driver relates to
|
||||
7. **Vehicle** - Select a vehicle to assign this driver to
|
||||
8. **City** - The city of the driver
|
||||
9. **Country** - The country of the driver
|
||||
10. Click Create
|
||||
|
||||
### Export Drivers
|
||||
|
||||
You can export your drivers in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- 
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
@@ -40,4 +73,4 @@ Create a file at `src/pages/my-markdown-page.md`:
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). -->
|
||||
|
||||
@@ -2,42 +2,36 @@
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Vehicles
|
||||
# 🚚 Vehicles
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
💡 Vehicles can be used to assign new orders, drivers and fleets to.
|
||||
|
||||
- `src/pages/index.js` → `localhost:3000/`
|
||||
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||
- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
|
||||
### View Vehicles
|
||||
|
||||
## Create your first React Page
|
||||
View all vehicles by clicking on the vehicles section under Resources
|
||||
|
||||
Create a file at `src/pages/my-react-page.js`:
|
||||
### Create Vehicles
|
||||
|
||||
```jsx title="src/pages/my-react-page.js"
|
||||
import React from 'react';
|
||||
import Layout from '@theme/Layout';
|
||||
You can create new vehicles by clicking on the button on the top of the panel.
|
||||
|
||||
export default function MyReactPage() {
|
||||
return (
|
||||
<Layout>
|
||||
<h1>My React page</h1>
|
||||
<p>This is a React page</p>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
```
|
||||
1. **Create New Driver** - Enter the details to create the driver.
|
||||
1. **Internal ID** - You can set your own internal ID for this driver
|
||||
2. **Plate Number**
|
||||
3. **Vin Number**
|
||||
4. **Make**
|
||||
5. **Model**
|
||||
6. **Year**
|
||||
7. **Driver Assigned** - Assign the vehicle to your driver
|
||||
8. **Map Avatar**
|
||||
9. **Model Information**
|
||||
10. **Engine Information**
|
||||
11. **Fuel Information**
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
|
||||
### Export Vehicles
|
||||
|
||||
## Create your first Markdown Page
|
||||
You can export your vehicles in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
Create a file at `src/pages/my-markdown-page.md`:
|
||||
# Related articles
|
||||
|
||||
```mdx title="src/pages/my-markdown-page.md"
|
||||
# My Markdown page
|
||||
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io
|
||||
|
||||
@@ -2,9 +2,34 @@
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Fleets
|
||||
# 🚚 Fleets
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
💡 Fleets can be used to group vehicles and assign them to certain service areas or functions.
|
||||
|
||||
### View Fleets
|
||||
|
||||
View all fleets by clicking on the fleets section under Resources
|
||||
|
||||
### Create Fleet
|
||||
|
||||
You can create new Fleets by clicking on the button on the top of the panel.
|
||||
|
||||
1. **Create New Fleet** - Enter the details to create the Fleet.
|
||||
1. **Fleet Name**
|
||||
2. **Assign to Service Area** - Select a service area to assign the fleet to
|
||||
3. **Task / Mission** - Assign a specific task or mission to this fleet
|
||||
4. **Status** - Select the status of this Fleet
|
||||
|
||||
### Export Fleet
|
||||
|
||||
You can export your fleets in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
# Related articles
|
||||
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
<!-- Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
@@ -28,4 +53,4 @@ npm run serve
|
||||
|
||||
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
|
||||
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). -->
|
||||
|
||||
@@ -2,30 +2,28 @@
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Vendor
|
||||
# 🔀 Vendors
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
💡 Vendors can be created for vendors and additional 3rd party facilitators of yours. They can be assigned to specific orders. Vendors are automatically created through your Storefront if created.
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
### View Vendors
|
||||
|
||||
## Build your site
|
||||
View all vendors by clicking on the vendor section under Resources
|
||||
|
||||
Build your site **for production**:
|
||||
### Create Vendor
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
You can create new vendors by clicking on the button on the top of the panel.
|
||||
|
||||
The static files are generated in the `build` folder.
|
||||
1. **Create New Vendor** - You have the option to choose what type of vendor to create
|
||||
1. **Integrated Vendor**
|
||||
1. Integrated vendors are integrations to 3rd party facilitators which can be used to assign orders to.
|
||||
2. **Create Custom Vendor** - Enter the details to create your custom vendor.
|
||||
|
||||
## Deploy your site
|
||||
### Export Vendors
|
||||
|
||||
Test your production build locally:
|
||||
You can export your vendors in multiple formats by clicking the ‘Export’ pattern at the right of the panel.
|
||||
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
# Related articles
|
||||
|
||||
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
|
||||
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||
**Did we miss something?**
|
||||
Not to worry! Just email our support team at hello@fleetbase.io✌️
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Markdown Features
|
||||
@@ -71,7 +71,7 @@ Markdown code blocks are supported with Syntax highlighting.
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
|
||||
@@ -129,20 +129,21 @@ This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
```
|
||||
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
export const Highlight = ({ children, color }) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_position: 6
|
||||
|
||||
# Congratulations!
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
💡 You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_position: 3
|
||||
|
||||
# Create a Blog Post
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
💡 Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_position: 2
|
||||
|
||||
# Create a Document
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
💡 Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_position: 1
|
||||
|
||||
# Orders
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
💡 Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
- `src/pages/index.js` → `localhost:3000/`
|
||||
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_position: 5
|
||||
|
||||
# Deploy your site
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
💡 Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ sidebar_position: 5
|
||||
|
||||
# Deploy your site
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
💡 Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
|
||||
3
docs/src/pages/drivers.md
Normal file
3
docs/src/pages/drivers.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# My Markdown page
|
||||
|
||||
This is a Markdown page
|
||||
BIN
docs/static/img/view-drivers.png
vendored
Normal file
BIN
docs/static/img/view-drivers.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 228 KiB |
Reference in New Issue
Block a user