diff --git a/docs/guides/admin/_category_.json b/docs/guides/admin/_category_.json new file mode 100644 index 0000000..66251ce --- /dev/null +++ b/docs/guides/admin/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Admin", + "position": 7, + "link": { + "type": "generated-index", + "description": "Getting Started with using Fleetbase" + } +} 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 new file mode 100644 index 0000000..ba984f9 --- /dev/null +++ b/docs/guides/admin/introduction.md @@ -0,0 +1,91 @@ +--- +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/console/_category_.json b/docs/guides/console/_category_.json new file mode 100644 index 0000000..60074f9 --- /dev/null +++ b/docs/guides/console/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Console", + "position": 1, + "link": { + "type": "generated-index", + "description": "Getting Started with using Fleetbase" + } +} diff --git a/docs/guides/console/dashboard.md b/docs/guides/console/dashboard.md new file mode 100644 index 0000000..7a263ca --- /dev/null +++ b/docs/guides/console/dashboard.md @@ -0,0 +1,23 @@ +--- +title: Dashboard +sidebar_position: 2 +slug: /guides/console/dashboard +--- + +## Dashboard Overview + +The dashboard is your centralised place for a complete overview of your operations, fully configurable and customizable. + +![Alt text](image.png) + +### Create New Dashboard + +You can create as many dashboards as you need, click on the 'Dashboard' on the top right to create a new dashboard. + +![Alt text](image-1.png) + +### Widgets + +The dashboard is compiled of 'Widgets'. Fleetbase comes with standard widgets for insights into metric for FleetOps and Storefront. Users can create their own custom widgets or reach out to one of our team for the same. + +To learn more, please visit the 'Widgets' section. \ No newline at end of file diff --git a/docs/guides/console/image-1.png b/docs/guides/console/image-1.png new file mode 100644 index 0000000..a47539c Binary files /dev/null and b/docs/guides/console/image-1.png differ diff --git a/docs/guides/console/image-2.png b/docs/guides/console/image-2.png new file mode 100644 index 0000000..073a54a Binary files /dev/null and b/docs/guides/console/image-2.png differ diff --git a/docs/guides/console/image-3.png b/docs/guides/console/image-3.png new file mode 100644 index 0000000..4d4f893 Binary files /dev/null and b/docs/guides/console/image-3.png differ diff --git a/docs/guides/console/image-4.png b/docs/guides/console/image-4.png new file mode 100644 index 0000000..19a58e7 Binary files /dev/null and b/docs/guides/console/image-4.png differ diff --git a/docs/guides/console/image-5.png b/docs/guides/console/image-5.png new file mode 100644 index 0000000..3f3c0c0 Binary files /dev/null and b/docs/guides/console/image-5.png differ diff --git a/docs/guides/console/image-6.png b/docs/guides/console/image-6.png new file mode 100644 index 0000000..49132e1 Binary files /dev/null and b/docs/guides/console/image-6.png differ diff --git a/docs/guides/console/image-7.png b/docs/guides/console/image-7.png new file mode 100644 index 0000000..755414c Binary files /dev/null and b/docs/guides/console/image-7.png differ diff --git a/docs/guides/console/image-8.png b/docs/guides/console/image-8.png new file mode 100644 index 0000000..4a1a544 Binary files /dev/null and b/docs/guides/console/image-8.png differ diff --git a/docs/guides/console/image.png b/docs/guides/console/image.png new file mode 100644 index 0000000..58df647 Binary files /dev/null and b/docs/guides/console/image.png differ diff --git a/docs/guides/console/overview.md b/docs/guides/console/overview.md new file mode 100644 index 0000000..1bfa3fe --- /dev/null +++ b/docs/guides/console/overview.md @@ -0,0 +1,44 @@ +--- +title: Overview +sidebar_position: 1 +slug: /guides/console/overview +--- +## Console Overview + +The console is the backbone of Fleetbase. It shows all of your installed extensions, cutomized dashboards and your company / user settings. + +### Navigation Bar + +The top navigation bar shows all of your extensions currently available. + +![Alt text](image-2.png) + +### Dashboard + +As you enter the console, you will see the Dashboard. + +This dashboard is fully customizble, you can learn more in the Dashboard Section. + +![Alt text](image-3.png) + +### Notifications / Chat / Translation + +View all of your system notifications, switch to multiple languages and create instant chat channels using the features in the screenshot below: + +![Alt text](image-4.png) + +### Company & User Settings + +Click into the Company Name or the User Profile Image to access settings such as: + +- Organisation Settings +- Create or Join or Switch Organisations +- Update Billing Settings +- Explore Extensions +- Access System Admin +- View or Update Profile / Passwords + +![Alt text](image-5.png) + + + diff --git a/docs/guides/console/widgets.md b/docs/guides/console/widgets.md new file mode 100644 index 0000000..8824da9 --- /dev/null +++ b/docs/guides/console/widgets.md @@ -0,0 +1,21 @@ +--- +title: Widgets +sidebar_position: 3 +slug: /guides/console/widgets +--- + +## Widgets + +The dashboard is compiled of 'Widgets'. Fleetbase comes with standard widgets for insights into metric for FleetOps and Storefront. Users can create their own custom widgets or reach out to one of our team for the same. + +### Create New Widget + +Once you have created a new Dashboard, you can then add the exisiting Widgets to this dashboard. + +Click on the ... dots on the right top corner, and then click 'Add Widgets'. + +![Alt text](image-8.png) + +Once you are here, you can select the widgets you need. If you are looking to create new widgets, you can do so from the back end, or reach out to the team. + +![Alt text](image-7.png) \ No newline at end of file diff --git a/docs/guides/developers-console/_category_.json b/docs/guides/developers-console/_category_.json new file mode 100644 index 0000000..836ee62 --- /dev/null +++ b/docs/guides/developers-console/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Developers Console", + "position": 3, + "link": { + "type": "generated-index", + "description": "Getting Started with using Fleetbase" + } +} 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 new file mode 100644 index 0000000..fb6b0ff --- /dev/null +++ b/docs/guides/developers-console/introduction.md @@ -0,0 +1,33 @@ +--- +title: Introduction +sidebar_position: 1 +slug: /guides/console/introduction +--- +## Overview + +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. **Insights** - View API insights. + +![Alt text](image.png) + +2. **API Keys** - Create and view API Keys. + +![Alt text](image-1.png) + +3. **Webhooks** - Create and view webhook endpoints. + +![Alt text](image-2.png) + +4. **WebSockets** - View your webhooks success and errors. + +![Alt text](image-3.png) + +5. **Logs** - View all of the logs for your account. + +![Alt text](image-4.png) + +6. **Events** - View all of the logs for your account. + +![Alt text](image-5.png) + diff --git a/docs/guides/fleet-ops/_category_.json b/docs/guides/fleet-ops/_category_.json index c89dc2f..59f1b37 100644 --- a/docs/guides/fleet-ops/_category_.json +++ b/docs/guides/fleet-ops/_category_.json @@ -1,6 +1,6 @@ { "label": "Fleet-Ops", - "position": 3, + "position": 2, "link": { "type": "generated-index", "description": "Getting Started with using Fleetbase" diff --git a/docs/guides/fleet-ops/contacts.md b/docs/guides/fleet-ops/contacts.md new file mode 100644 index 0000000..7ac7eec --- /dev/null +++ b/docs/guides/fleet-ops/contacts.md @@ -0,0 +1,30 @@ +--- +title: Contacts +sidebar_position: 10 +slug: /guides/fleet-ops/contacts +--- + +## Overview + +Contacts can be defined in multiple ways. + +1. **Contacts** - Contacts can be any contacts you wish to document in the system, such as contractors / stakeholdersetc. +2. **Customers** - Customers can be the end customer your want to assign deliveries to. + +![Alt text](image-40.png) + +### Create Contact / Customer ### + +You can create a new contact by clicking on the button on the top of the panel. + +1. **Contact Details** - Populate your contact / customer details. +2. **Type** - Select from the list to select either 'Contact' or 'Customer'. + +![Alt text](image-41.png) + + +### Export Contacts ### + +Export contacts by selecting the contacts and then clicking the 'Export' button. + +![Alt text](image-42.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/dashboard.md b/docs/guides/fleet-ops/dashboard.md new file mode 100644 index 0000000..d0662f3 --- /dev/null +++ b/docs/guides/fleet-ops/dashboard.md @@ -0,0 +1,65 @@ +--- +title: Dashboard +sidebar_position: 2 +slug: /guides/fleet-ops/dashboard +--- + +## Overview + +The map view in FleetOps is probabsly where you will spend most of your time. + +Here, you can have a full overview of all of your drivers locations in real time, as well create and view orders, create and view service areas and add custom zoning. + +### Map View + +The map view shows a visual representation of the drivers, this is using the GPS from the mobile device, as long as the driver is online using the Navigator App you will be able to see their location. + +![Alt text](image.png) + +#### Create Order + +You can create an order directly from the dashboard by clicking on the 'Create New Order' button, or by clicking the first button in the left side bar. + +![Alt text](image-5.png) + +Navigate to the 'Orders' section to learn more. + +#### View Orders + +You can view orders directly from the dashboard by clicking the 3rd button on the left side bar. + +![Alt text](image-8.png) + +Navigate to the 'Orders' section to learn more. + +#### Search + +You can search for your order by simply clicking the second button on the left side bar, and then searching in the box above. + + ![Alt text](image-7.png) + +#### Create Service Areas + +You can create an service area directly from the dashboard by clicking on the 'Create New Service Area' button, or by clicking the fourth button in the left side bar. + +![Alt text](image-6.png) + +Navigate to the 'Service Areas' section to learn more. + +### Table View + +The Table View in FleetOps shows a full list of the orders created by the users in FleetOps, from here, you can bulk action orders, see the statuses of orders, and export all of your order details. + +![Alt text](image-9.png) + +#### Custom Columns + +Users can view and hide all of the columns they want to see in the table view. Simple click the columns tab and check or uncheck the required fields. + +![Alt text](image-10.png) + +#### Bulk Actions + +Once you select orders from the Table View, you can commit bulk actions on these orders. Simply navigate to the 'Bulk Action' button on the top right. + +![Alt text](image-12.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/drivers.md b/docs/guides/fleet-ops/drivers.md new file mode 100644 index 0000000..e1f483c --- /dev/null +++ b/docs/guides/fleet-ops/drivers.md @@ -0,0 +1,29 @@ +--- +title: Drivers +sidebar_position: 6 +slug: /guides/fleet-ops/drivers +--- + +## Overview + +Drivers can be used to assign new orders, vehicles and fleets to. + +![Alt text](image-28.png) + +### Create Drivers + +You can create new orders by clicking on the button on the top of the panel. + +1. **User Account** - If the driver has an exisiting user account in the system, you can link this account to create the new driver. +2. **Driver Details** - Add in the details of the driver. +3. **Avatar** - Select an avatar, this will be displayed when you view the driver on the map. +4. **Navigator App** - The phone number you add to the driver will be used to login to the Driver app once you assign the order to them. + + +![Alt text](image-29.png) + +### Export Drivers ### + +Export drivers by selecting the drivers and then clicking the 'Export' button. + +![Alt text](image-30.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/fleets.md b/docs/guides/fleet-ops/fleets.md new file mode 100644 index 0000000..a5caaf7 --- /dev/null +++ b/docs/guides/fleet-ops/fleets.md @@ -0,0 +1,37 @@ +--- +title: Fleets +sidebar_position: 8 +slug: /guides/fleet-ops/fleets +--- + +## Overview + +You can group drivers & vehicles to Fleets. This can then be used to assign Fleets to specific service areas or zones. + +![Alt text](image-28.png) + +### Create Fleets + +You can create new fleets by clicking on the button on the top of the panel. + +1. **Fleet Name** - Add in the name of the Fleet. +2. **Parent Fleet** - This is your Fleet hierarchy, you can create a fleet and then sub fleets under it. +3. **Vendor** - Vendors can be 3rd party logistics companies that you assign order to, you can assign a Fleet to a Vendor. +4. **Assign to Service Area** - If you have multiple Fleets, you can assign specific Fleets to Service Areas. +5. **Assign to Zone** - Assign this Fleet to a specific Zone. +6. **Status** - Set if this fleet is active or not. +7. **Task / Mission** - Define the mission for this Fleet. + +![Alt text](image-33.png) + +### Assign Drivers & Vehicles ### + +Once you have created the Fleet, click the three dots and click 'View Details'. From here, you can assign the specific drivers and vehicles to this Fleet. + +![Alt text](image-35.png) + +### Export Fleets ### + +Export vehicles by selecting the drivers and then clicking the 'Export' button. + +![Alt text](image-34.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/fuel-reports.md b/docs/guides/fleet-ops/fuel-reports.md new file mode 100644 index 0000000..ffd40e5 --- /dev/null +++ b/docs/guides/fleet-ops/fuel-reports.md @@ -0,0 +1,33 @@ +--- +title: Fuel Reports +sidebar_position: 12 +slug: /guides/fleet-ops/fuel-reports +--- + +## Overview + +You can upload and track fuel reports for your fleet. + +![Alt text](image-46.png) + +### Create Fuel Reports ### + +You can create a fuel reports by clicking on the button on the top of the panel. + +1. **Reporter** - Select the user who is submitting this fuel report. +2. **Driver** - Select the driver that is submitting this fuel report. +3. **Vehicle** - Select vehicle that this fuel report relates to. +4. **Status** - Select the status of the fuel report, if it is in draft mode or published etc. +5. **Odometer** - Populate the current odometer reading at the time of this fuel report. +6. **Cost** - Populate the cost of this fuel report. +7. **Volume** - Populate the liters that have been added for this fuel report. +8. **Coordinates** - Select the coordinates that relate to this fuel report. + +![Alt text](image-47.png) + + +### Export Fuel Reports ### + +Export fuel reports by selecting the fuel reports and then clicking the 'Export' button. + +![Alt text](image-48.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/getting-started.md b/docs/guides/fleet-ops/getting-started.md new file mode 100644 index 0000000..bc1a27a --- /dev/null +++ b/docs/guides/fleet-ops/getting-started.md @@ -0,0 +1,93 @@ +--- +title: Getting Started +sidebar_position: 15 +slug: /guides/fleet-ops/getting-started +--- + +## 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-1.png b/docs/guides/fleet-ops/image-1.png new file mode 100644 index 0000000..0cab72d Binary files /dev/null and b/docs/guides/fleet-ops/image-1.png differ diff --git a/docs/guides/fleet-ops/image-10.png b/docs/guides/fleet-ops/image-10.png new file mode 100644 index 0000000..79ca28a Binary files /dev/null and b/docs/guides/fleet-ops/image-10.png differ diff --git a/docs/guides/fleet-ops/image-11.png b/docs/guides/fleet-ops/image-11.png new file mode 100644 index 0000000..ca3ee4e Binary files /dev/null and b/docs/guides/fleet-ops/image-11.png differ diff --git a/docs/guides/fleet-ops/image-12.png b/docs/guides/fleet-ops/image-12.png new file mode 100644 index 0000000..f444ecf Binary files /dev/null and b/docs/guides/fleet-ops/image-12.png differ diff --git a/docs/guides/fleet-ops/image-13.png b/docs/guides/fleet-ops/image-13.png new file mode 100644 index 0000000..9d7975d Binary files /dev/null and b/docs/guides/fleet-ops/image-13.png differ diff --git a/docs/guides/fleet-ops/image-14.png b/docs/guides/fleet-ops/image-14.png new file mode 100644 index 0000000..9d7975d Binary files /dev/null and b/docs/guides/fleet-ops/image-14.png differ diff --git a/docs/guides/fleet-ops/image-15.png b/docs/guides/fleet-ops/image-15.png new file mode 100644 index 0000000..1a4cd46 Binary files /dev/null and b/docs/guides/fleet-ops/image-15.png differ diff --git a/docs/guides/fleet-ops/image-16.png b/docs/guides/fleet-ops/image-16.png new file mode 100644 index 0000000..607f0c4 Binary files /dev/null and b/docs/guides/fleet-ops/image-16.png differ diff --git a/docs/guides/fleet-ops/image-17.png b/docs/guides/fleet-ops/image-17.png new file mode 100644 index 0000000..72a565a Binary files /dev/null and b/docs/guides/fleet-ops/image-17.png differ diff --git a/docs/guides/fleet-ops/image-18.png b/docs/guides/fleet-ops/image-18.png new file mode 100644 index 0000000..f880130 Binary files /dev/null and b/docs/guides/fleet-ops/image-18.png differ diff --git a/docs/guides/fleet-ops/image-19.png b/docs/guides/fleet-ops/image-19.png new file mode 100644 index 0000000..0a93713 Binary files /dev/null and b/docs/guides/fleet-ops/image-19.png differ diff --git a/docs/guides/fleet-ops/image-2.png b/docs/guides/fleet-ops/image-2.png new file mode 100644 index 0000000..0ebdb7e Binary files /dev/null and b/docs/guides/fleet-ops/image-2.png differ diff --git a/docs/guides/fleet-ops/image-20.png b/docs/guides/fleet-ops/image-20.png new file mode 100644 index 0000000..8fd4b95 Binary files /dev/null and b/docs/guides/fleet-ops/image-20.png differ diff --git a/docs/guides/fleet-ops/image-21.png b/docs/guides/fleet-ops/image-21.png new file mode 100644 index 0000000..3b0e5a4 Binary files /dev/null and b/docs/guides/fleet-ops/image-21.png differ diff --git a/docs/guides/fleet-ops/image-22.png b/docs/guides/fleet-ops/image-22.png new file mode 100644 index 0000000..702688a Binary files /dev/null and b/docs/guides/fleet-ops/image-22.png differ diff --git a/docs/guides/fleet-ops/image-23.png b/docs/guides/fleet-ops/image-23.png new file mode 100644 index 0000000..adf34b1 Binary files /dev/null and b/docs/guides/fleet-ops/image-23.png differ diff --git a/docs/guides/fleet-ops/image-24.png b/docs/guides/fleet-ops/image-24.png new file mode 100644 index 0000000..adf34b1 Binary files /dev/null and b/docs/guides/fleet-ops/image-24.png differ diff --git a/docs/guides/fleet-ops/image-25.png b/docs/guides/fleet-ops/image-25.png new file mode 100644 index 0000000..1b68b7e Binary files /dev/null and b/docs/guides/fleet-ops/image-25.png differ diff --git a/docs/guides/fleet-ops/image-26.png b/docs/guides/fleet-ops/image-26.png new file mode 100644 index 0000000..d04bb35 Binary files /dev/null and b/docs/guides/fleet-ops/image-26.png differ diff --git a/docs/guides/fleet-ops/image-27.png b/docs/guides/fleet-ops/image-27.png new file mode 100644 index 0000000..f15bbd4 Binary files /dev/null and b/docs/guides/fleet-ops/image-27.png differ diff --git a/docs/guides/fleet-ops/image-28.png b/docs/guides/fleet-ops/image-28.png new file mode 100644 index 0000000..6eaecfd Binary files /dev/null and b/docs/guides/fleet-ops/image-28.png differ diff --git a/docs/guides/fleet-ops/image-29.png b/docs/guides/fleet-ops/image-29.png new file mode 100644 index 0000000..f53685c Binary files /dev/null and b/docs/guides/fleet-ops/image-29.png differ diff --git a/docs/guides/fleet-ops/image-3.png b/docs/guides/fleet-ops/image-3.png new file mode 100644 index 0000000..3787392 Binary files /dev/null and b/docs/guides/fleet-ops/image-3.png differ diff --git a/docs/guides/fleet-ops/image-30.png b/docs/guides/fleet-ops/image-30.png new file mode 100644 index 0000000..7ce8a87 Binary files /dev/null and b/docs/guides/fleet-ops/image-30.png differ diff --git a/docs/guides/fleet-ops/image-31.png b/docs/guides/fleet-ops/image-31.png new file mode 100644 index 0000000..1dac70f Binary files /dev/null and b/docs/guides/fleet-ops/image-31.png differ diff --git a/docs/guides/fleet-ops/image-32.png b/docs/guides/fleet-ops/image-32.png new file mode 100644 index 0000000..f5720c4 Binary files /dev/null and b/docs/guides/fleet-ops/image-32.png differ diff --git a/docs/guides/fleet-ops/image-33.png b/docs/guides/fleet-ops/image-33.png new file mode 100644 index 0000000..af44814 Binary files /dev/null and b/docs/guides/fleet-ops/image-33.png differ diff --git a/docs/guides/fleet-ops/image-34.png b/docs/guides/fleet-ops/image-34.png new file mode 100644 index 0000000..aa42cc4 Binary files /dev/null and b/docs/guides/fleet-ops/image-34.png differ diff --git a/docs/guides/fleet-ops/image-35.png b/docs/guides/fleet-ops/image-35.png new file mode 100644 index 0000000..4a17c3d Binary files /dev/null and b/docs/guides/fleet-ops/image-35.png differ diff --git a/docs/guides/fleet-ops/image-36.png b/docs/guides/fleet-ops/image-36.png new file mode 100644 index 0000000..988e952 Binary files /dev/null and b/docs/guides/fleet-ops/image-36.png differ diff --git a/docs/guides/fleet-ops/image-37.png b/docs/guides/fleet-ops/image-37.png new file mode 100644 index 0000000..e9b7340 Binary files /dev/null and b/docs/guides/fleet-ops/image-37.png differ diff --git a/docs/guides/fleet-ops/image-38.png b/docs/guides/fleet-ops/image-38.png new file mode 100644 index 0000000..f54ebc3 Binary files /dev/null and b/docs/guides/fleet-ops/image-38.png differ diff --git a/docs/guides/fleet-ops/image-39.png b/docs/guides/fleet-ops/image-39.png new file mode 100644 index 0000000..620f043 Binary files /dev/null and b/docs/guides/fleet-ops/image-39.png differ diff --git a/docs/guides/fleet-ops/image-4.png b/docs/guides/fleet-ops/image-4.png new file mode 100644 index 0000000..3787392 Binary files /dev/null and b/docs/guides/fleet-ops/image-4.png differ diff --git a/docs/guides/fleet-ops/image-40.png b/docs/guides/fleet-ops/image-40.png new file mode 100644 index 0000000..620f043 Binary files /dev/null and b/docs/guides/fleet-ops/image-40.png differ diff --git a/docs/guides/fleet-ops/image-41.png b/docs/guides/fleet-ops/image-41.png new file mode 100644 index 0000000..295b4e5 Binary files /dev/null and b/docs/guides/fleet-ops/image-41.png differ diff --git a/docs/guides/fleet-ops/image-42.png b/docs/guides/fleet-ops/image-42.png new file mode 100644 index 0000000..73120e3 Binary files /dev/null and b/docs/guides/fleet-ops/image-42.png differ diff --git a/docs/guides/fleet-ops/image-43.png b/docs/guides/fleet-ops/image-43.png new file mode 100644 index 0000000..f534d98 Binary files /dev/null and b/docs/guides/fleet-ops/image-43.png differ diff --git a/docs/guides/fleet-ops/image-44.png b/docs/guides/fleet-ops/image-44.png new file mode 100644 index 0000000..386f69c Binary files /dev/null and b/docs/guides/fleet-ops/image-44.png differ diff --git a/docs/guides/fleet-ops/image-45.png b/docs/guides/fleet-ops/image-45.png new file mode 100644 index 0000000..55ff515 Binary files /dev/null and b/docs/guides/fleet-ops/image-45.png differ diff --git a/docs/guides/fleet-ops/image-46.png b/docs/guides/fleet-ops/image-46.png new file mode 100644 index 0000000..3c1addc Binary files /dev/null and b/docs/guides/fleet-ops/image-46.png differ diff --git a/docs/guides/fleet-ops/image-47.png b/docs/guides/fleet-ops/image-47.png new file mode 100644 index 0000000..ecf6b7a Binary files /dev/null and b/docs/guides/fleet-ops/image-47.png differ diff --git a/docs/guides/fleet-ops/image-48.png b/docs/guides/fleet-ops/image-48.png new file mode 100644 index 0000000..c1a8dd9 Binary files /dev/null and b/docs/guides/fleet-ops/image-48.png differ diff --git a/docs/guides/fleet-ops/image-49.png b/docs/guides/fleet-ops/image-49.png new file mode 100644 index 0000000..9f36c67 Binary files /dev/null and b/docs/guides/fleet-ops/image-49.png differ diff --git a/docs/guides/fleet-ops/image-5.png b/docs/guides/fleet-ops/image-5.png new file mode 100644 index 0000000..e8a73a3 Binary files /dev/null and b/docs/guides/fleet-ops/image-5.png differ diff --git a/docs/guides/fleet-ops/image-50.png b/docs/guides/fleet-ops/image-50.png new file mode 100644 index 0000000..33763fa Binary files /dev/null and b/docs/guides/fleet-ops/image-50.png differ 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-6.png b/docs/guides/fleet-ops/image-6.png new file mode 100644 index 0000000..ba7d67e Binary files /dev/null and b/docs/guides/fleet-ops/image-6.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/fleet-ops/image-7.png b/docs/guides/fleet-ops/image-7.png new file mode 100644 index 0000000..70c4750 Binary files /dev/null and b/docs/guides/fleet-ops/image-7.png differ diff --git a/docs/guides/fleet-ops/image-8.png b/docs/guides/fleet-ops/image-8.png new file mode 100644 index 0000000..add1d08 Binary files /dev/null and b/docs/guides/fleet-ops/image-8.png differ diff --git a/docs/guides/fleet-ops/image-9.png b/docs/guides/fleet-ops/image-9.png new file mode 100644 index 0000000..ea0b846 Binary files /dev/null and b/docs/guides/fleet-ops/image-9.png differ diff --git a/docs/guides/fleet-ops/image.png b/docs/guides/fleet-ops/image.png new file mode 100644 index 0000000..404a795 Binary files /dev/null and b/docs/guides/fleet-ops/image.png differ diff --git a/docs/guides/fleet-ops/introduction.md b/docs/guides/fleet-ops/introduction.md index 821286e..c9a48c0 100644 --- a/docs/guides/fleet-ops/introduction.md +++ b/docs/guides/fleet-ops/introduction.md @@ -3,3 +3,83 @@ title: Introduction sidebar_position: 1 slug: /guides/fleet-ops/introduction --- +## What is FleetOps? + +FleetOps is a dynamic last-mile operations and fleet management system. + +### Dashboard + +The Dashboard is your central place for operations. + +- View Drivers on Map +- Create Orders +- View Orders +- View Service Areas +- Create Service Areas +- Export Orders + +Navigate to the 'Dashboard' section to learn more. + +### Service Rates + +Create custom service rates for your different delivery operations. + +Navigate to the 'Service Rates' section to learn more. + +### Scheduler + +The scheduler allows your to have an overview of all your orders, and view your schedule in a calandar view. + +Naviagte to the 'Scheduler' section to learn more. + +### Drivers + +The Drivers section is for management and overview of all the drivers in your organisation. + +Navigate to the 'Drivers' section to learn more. + +### Vehicles + +The Vehicles section is for management and overview of all the vehicles in your organisation. + +Navigate to the 'Vehicles' section to learn more. + +### Fleets + +The Fleets section is for management and overview of all the fleets in your organisation. + +Navigate to the 'Fleets' section to learn more. + +### Vendors + +The Vendors section is for management and overview of all the vendors in your organisation. + +Navigate to the 'Vendors' section to learn more. + +### Contacts + +The Contacts section is for management and overview of all the contacts in your organisation. + +Navigate to the 'Contacts' section to learn more. + +### Places + +The Places section is for management and overview of all the places in your organisation. + +Navigate to the 'Places' section to learn more. + +### Fuel Reports + +The Fuel Reports section is for management and overview of all the fuel reports in your organisation. + +Navigate to the 'Fuel Reports' section to learn more. + +### Issues + +The Issues section is for management and overview of all the issues in your organisation. + +Navigate to the 'Issues' section to learn more. + +### Navigator App + + diff --git a/docs/guides/fleet-ops/issues.md b/docs/guides/fleet-ops/issues.md new file mode 100644 index 0000000..d2bbda7 --- /dev/null +++ b/docs/guides/fleet-ops/issues.md @@ -0,0 +1,37 @@ +--- +title: Issues +sidebar_position: 13 +slug: /guides/fleet-ops/issues +--- + +## Overview + +Operations can create and track issues in real time as they occur in the field. This can be created here and also by the driver on the Navigator App. + +![Alt text](image-46.png) + +### Create Fuel Reports ### + +You can create a fuel reports by clicking on the button on the top of the panel. + +1. **Reported By** - Select the user who is reporting this issue. +2. **Assigned To** - Select the user that is required to resolve this issue. +3. **Driver** - Select the driver assigned to the issue. +4. **Vehicle** - Select the vehicle assigned to the issue. +5. **Issue Type** - Populate the type of issue. +6. **Issue Category** - Select the category of the issue. +7. **Issue Report** - Describe the full details of the issue. +8. **Issue Tags** - Add multiple tags for this issue for easier searching. +8. **Issue Priority** - Select the priority of this issue. +8. **Status** - Select tcurrent status of this issue. +8. **Coordinates** - Select the coordinates that relate to this iisue. + + +![Alt text](image-49.png) + + +### Export Issues ### + +Export issues by selecting the issues and then clicking the 'Export' button. + +![Alt text](image-50.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/order-configuration.md b/docs/guides/fleet-ops/order-configuration.md index c489b8d..58075b5 100644 --- a/docs/guides/fleet-ops/order-configuration.md +++ b/docs/guides/fleet-ops/order-configuration.md @@ -1,5 +1,82 @@ --- title: Order Configuration -sidebar_position: 2 +sidebar_position: 5 slug: /guides/fleet-ops/order-config --- + +## Overview + +The order configuration section in Fleetbase is the backbone of what fields are included when a new order is created, the activity flow and the activity statuses of the orders, and also the type of entity that is attached to the order. + +When creating a new order, once you specify the order type, this will pull in the fields and logic configured in that particular order configuration. + +### Creating New Order Configuration + +![Alt text](image-22.png) + +1. **New Order Config** - Click here to create a new order configuration. +2. **Config Name** - Set the name of the configuration. +3. **Config Description** - Set the description of the order configuration. +4. **Config Tag** - Set tags for this order configuration. + +### Select Order Configuration + +From the drop down, you can see all of the order configs you have created, select one to view the details, custom fields, activity flows and entities. + +![Alt text](image-23.png) + +### Creating Custom Fields + +Custom fields can be created and importing into the new order form when creating a new orders. This can be for additonal fields that are not in the basic order forms. These fields can also be used to create custom activity logic as well. + +![Alt text](image-25.png) + +1. **Create Field Group** - Click here to create a group of fields, you can create as many as you like. +2. **Create Field** - Click here to create the custom field, this will sit within the field group. +3. **Field Lable** - This is the name of the field. +4. **Field Description** - This is the description of the field. +5. **Field Help Text** - Set a help text for this field. +6. **Field Is Required** - If this is toggled, you wont be able to submit the order without this field populated. +7. **Field Editable** - If this is toggled, you will be able to edit this field. +8. **Field Type** - You can select from a number of different field types, such as date / time input, money input, radio button etc. +9. **Field Option** - If you select radio button, you can add in different options for the user to choose from. +10. **Column Span** - You can choose how many columns this field will span over. + +Once you have finished, click 'Create New Field', this will be available when you create a new order and select this order config. + +### Creating Custom Activity Flow + +Cutsom activity flows can be created so that specific logic conditions can be created, depending on the companies requirements. These activity flows will be what the driver and the operations staff will have to confirm through, before the order can be completed. For example, you can create + +![Alt text](image-26.png) + +1. **Order Status** - You can see each order status and the details here, when you add a new status, it will appear in this flow chart. +2. **Create New Status** - Click the + button to create a new order status and pull out the activity status details. +3. **Status Key** - Enter a key that will be used for programatic decision making. +4. **Status Code** - This is where you can set a unique identifier. +5. **Status** - This is what you will set to show the status to the end customer. +6. **Details** - This is the details of the status that will be sent to the end customer. +7. **Completes Order** - If this is toggled, this status will complete the order. +8. **POD** - If this is toggled, this status will require a proof of delivery +9. **Select POD** - Select from the different types of proof of delivery. +10. **Activity Logic** - This is where (from your custom fields) you can set custom logic conditions. You can create as many logic conditions as you like. Please reach out to us if you need more assistance with this. +11. **Events** - Add a specific event to this status. + +Once you have finalised, click save. + +### Creating Custom Entities + +Entities in Fleetbase are the types of specifics of the payloads that are moving moved. + +For example, here you can create containers, parcle types, waste types etc etc. + +Again, once you create an entitiy type, once you pull this specific order configuration in, then these entities will be assigned to the order as well. + +![Alt text](image-27.png) + +1. **New Custom Entity** - Click here to create the new custom entity. +2. **Details** - Populate the main details of the entity, for example the Name, Description & Type. +3. **Image** - Add in a new image for this entity. +4. **Measurements** - Set your custom measurements for the entity. + +Once you save, your custom order config will be completed, please see the 'Order' section for steps on how to create a new order. diff --git a/docs/guides/fleet-ops/places.md b/docs/guides/fleet-ops/places.md new file mode 100644 index 0000000..56cb9b2 --- /dev/null +++ b/docs/guides/fleet-ops/places.md @@ -0,0 +1,28 @@ +--- +title: Places +sidebar_position: 11 +slug: /guides/fleet-ops/places +--- + +## Overview + +Places are used to assign waypoints to orders. Places can be automatically created when the order is created, or you can create them manually and assign when creating the order. + +![Alt text](image-43.png) + +### Create Place ### + +You can create a new place by clicking on the button on the top of the panel. + +1. **Name** - Populate the name for this place, you can search by this name when creating the order. +2. **Select From Map** - Add in the address by selecting 'Select from map', once you do this, the form will auto populate. +3. **Avatar** - Select the custom avatar to view the place on the map. + +![Alt text](image-44.png) + + +### Export Places ### + +Export places by selecting the places and then clicking the 'Export' button. + +![Alt text](image-45.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/scheduler.md b/docs/guides/fleet-ops/scheduler.md new file mode 100644 index 0000000..5d54980 --- /dev/null +++ b/docs/guides/fleet-ops/scheduler.md @@ -0,0 +1,19 @@ +--- +title: Scheduler +sidebar_position: 4 +slug: /guides/fleet-ops/scheduler +--- + +## Overview + +The Scheduler shows all of your Unscheduled and Scheduled orders, you can then view all of them in a easy to digest calendar view. + +Additional Zones can be created within the Service Area. + +![Alt text](image-20.png) + +1. **Unscheduled Orders** - All of these orders have been created but not given a scheduled date for delivery. +2. **Scheduled Orders** - All of these orders have been created with a scheduled delivery date and time. . +3. **Orders** - These are the orders that have been scheduled, if you want to see more details for a specific order, you can click into it. + +![Alt text](image-21.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/service-areas.md b/docs/guides/fleet-ops/service-areas.md new file mode 100644 index 0000000..fb6a66f --- /dev/null +++ b/docs/guides/fleet-ops/service-areas.md @@ -0,0 +1,32 @@ +--- +title: Service Areas +sidebar_position: 3 +slug: /guides/fleet-ops/service-areas +--- + +## Overview + +Service areas in FleetOps are used to assign fleets, vehicles, drivers and even service rates to. Custom logic can be created on the back end as well, for things like IOT device integrations and geofencing. + +Additional Zones can be created within the Service Area. + +![Alt text](image-19.png) + +### Create Service Area + +From the Dashboard section, you can view and create new service areas from the 4th button on the bar on the left hand side. + +![Alt text](image-17.png) + +Below are the steps needed to create Service Areas & Zones. + +1. **Manage Service Area** - Navigate to the Service Area section. +2. **Create Service Area** - Click on 'Create New Service Area'. Once you click on this, there will be tools for you to create the service area. +3. **Select Drawing Tool** - Select the type of drawing tool you would like to use to draw your service area. +4. **Draw and Confirm** - Use the drawing tool to create the service area you would like to start with. Once you connect the polygon back together, the service area will be created. + +### Create Zones + +Zones are geofenced areas within Service Areas. Once the service are has been created, you can Right Click into the service area, and select 'Create Zone'. + +![Alt text](image-18.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/service-rates.md b/docs/guides/fleet-ops/service-rates.md new file mode 100644 index 0000000..5167c5a --- /dev/null +++ b/docs/guides/fleet-ops/service-rates.md @@ -0,0 +1,32 @@ +--- +title: Service Rates +sidebar_position: 3 +slug: /guides/fleet-ops/service-rates +--- + +## Overview + +Service Rates in Fleetops are used to calculate delivery fees automatically when a new order is created. + +Users can link service rates to specific order types (see Order Configuration section) and even create custom algorithims to calulate service rate fees. + +![Alt text](image-13.png) + +### Create Service Rates + +Once you have navigated to the Service Area section, you can create a new Service Rate by clicking 'New' + +1. **Service Name** - This is the name for your service rate. +2. **Service Order Type** - Restricting this service rate to the order type means, when you create the order and select the specific service type, only this rate calculation will be used. +3. **Base Fee** - The standard base fee you want to set for this service rate. +4. **Rate Calculation Method** + - **Fixed Meter** - This option defines a fixed fee per kilometer. + - **Per Meter** - this optons allows the service to be calculated per kilometer or meter, this means you define a flat fee which is then multiplied by the distance which can be either meter or kilometer. + - **Per Drop-off** - This options defines a dixed fee per drop-offs + - **Custom Algorithm** - This option is to define a custom calculation for this service's fee with variables. Note that variables must be wrapped in a single curly brace. +5. **Duration Terms** - You can add additional terms of service regarding duration for this service rate. +6. **Cash on Delivery** - Toggle this to enable cash on delivery for orders. +7. **Peak Hours** - Toggle this to add an additional fee for peak hours. +8. **Restrict Service** - Restrict this service to an order type, you can learn more about this in the Order Configuration. + +![Alt text](image-15.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/vehicles.md b/docs/guides/fleet-ops/vehicles.md new file mode 100644 index 0000000..29e4b0b --- /dev/null +++ b/docs/guides/fleet-ops/vehicles.md @@ -0,0 +1,26 @@ +--- +title: Vehicles +sidebar_position: 7 +slug: /guides/fleet-ops/vehicles +--- + +## Overview + +Vehicles can be used to assign new orders, vehicles and fleets to. + +![Alt text](image-28.png) + +### Create Drivers + +You can create new orders by clicking on the button on the top of the panel. + +1. **Vehicle Details** - Add in the details of the vehicle. +2. **Avatar** - Select an avatar, this will be displayed when you view the vehicle on the map. + +![Alt text](image-31.png) + +### Export Vehicles ### + +Export vehicles by selecting the drivers and then clicking the 'Export' button. + +![Alt text](image-32.png) \ No newline at end of file diff --git a/docs/guides/fleet-ops/vendors.md b/docs/guides/fleet-ops/vendors.md new file mode 100644 index 0000000..75dceab --- /dev/null +++ b/docs/guides/fleet-ops/vendors.md @@ -0,0 +1,37 @@ +--- +title: Vendors +sidebar_position: 9 +slug: /guides/fleet-ops/vendors +--- + +## Overview + +Vendors can be defined in multiple ways. + +1. **Vendors** - This can be a 3rd party logistics company that is faciliting the delivery on your behalf, or it can be defined as your customer you are delivery goods on behalf of. +2. **Integrated Vendors** - Integrated vendors are the same as the above, but there is an exisiting integration either to recieve orders, or assign delivery orders to them, and recieved automated updates. + +![Alt text](image-36.png) + +### Create Integrated Vendor ### + +You can create a new vendor by clicking on the button on the top of the panel. + +1. **Select Vendor Type** - Select 'Integrated Vendor'. +2. **Choose Vendor Provider** - Select from the list of integrated vendor, then populate your API details for this vendor. + +![Alt text](image-37.png) + +### Create Custom Vendor ### + +You can create a new vendor by clicking on the button on the top of the panel. + +1. **Select Vendor Type** - Select 'Custom Vendor'. +2. **Vendor Details** - Populate the details for your custom vendor. + + +### Export Vendors ### + +Export vendors by selecting the vendors and then clicking the 'Export' button. + +![Alt text](image-38.png) \ No newline at end of file diff --git a/docs/guides/iam/_category_.json b/docs/guides/iam/_category_.json new file mode 100644 index 0000000..a0fb8c8 --- /dev/null +++ b/docs/guides/iam/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "IAM", + "position": 5, + "link": { + "type": "generated-index", + "description": "Getting Started with using Fleetbase" + } +} 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 new file mode 100644 index 0000000..dd29884 --- /dev/null +++ b/docs/guides/iam/introduction.md @@ -0,0 +1,23 @@ +--- +title: Introduction +sidebar_position: 1 +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/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) + +