⭐️ Overview

Fleetbase is a comprehensive, open-source platform for the management and orchestration of logistics and supply chain operations. This dual-natured platform serves not only as an efficient operational tool for companies within these industries but also as a robust foundational layer for developers. Its versatility emanates from its core, which is skillfully constructed around a series of "extensions," creating a flexible and customizable framework that accommodates a wide spectrum of supply chain and logistics requirements.

Every individual extension within Fleetbase is purposefully engineered to fulfill specific roles within the expansive ecosystem of supply chain and logistics. With inherent extensibility users have the freedom to craft their own extensions, thereby expanding the ecosystem and ensuring the platform's adaptability across a multitude of use cases. This extensible nature ensures that Fleetbase remains at the forefront of meeting diverse logistical and supply chain needs now and into the future.

📖 Table of contents

• What's Included
• Getting Started
• Use Cases
• Installation
• Extensions
• Apps
• Bugs and Feature Requests
• Documentation
• Contributing
• Community
• Creators
• License & Copyright

📦 What's Included

Fleetbase is more than just a platform; it's a versatile ecosystem carefully architected to empower developers and businesses alike. Fleetbase comes pre-installed with a few extensions that provide base functionality to get users and businesses started:

• Console: Fleetbase's frontend console is constructed using Ember.js and Ember Engines, providing a highly modular and extensible design. This not only enables the system to adapt and scale to your growing requirements but also simplifies the process of integrating new extensions. With the console's design, extensions can be easily installed using their respective package managers, thereby reducing complexity and time spent on integration.
• Fleetbase API: Fleetbase's backend API and framework, developed using the reliable Laravel framework, is thoughtfully designed with extension development and integration in mind. This robust and flexible infrastructure not only manages intricate data structures and transactions with grace but also facilitates the easy incorporation of new extensions via package managers. We provide additional packages that allow developers to craft their unique extensions, further enhancing the flexibility and extensibility of the Fleetbase ecosystem.
• Extensions: Fleetbase is designed to provide immediate utility out-of-the-box. It comes pre-installed with several key extensions
  • FleetOps: FleetOps, our comprehensive fleet management extension, caters to all aspects of last-mile operations. Some of it's features include:
    • Real-time tracking for vehicles and assets, ensuring optimal operational efficiency.
    • Order creation and management, facilitating seamless transaction processing. Service rates management, helping maintain financial transparency and profitability.
    • Fleet management, providing a holistic view and control of your fleet.
    • Third-party vendor integrations, allowing you to consolidate your resources.
    • API & Webhooks that not only offer increased interconnectivity but also serve to facilitate integrations with other services and applications, making FleetOps a truly versatile solution.
  • Storefront: Storefront is an extension that delivers headless commerce functionality, ideal for businesses aspiring to develop on-demand stores or marketplaces. It aims to facilitate seamless transactions while focusing on providing an excellent user experience.
  • Dev Console: The Dev Console extension is a developer's toolbox, providing resources such as:
    • API keys management, ensuring secure interactions with the application programming interface.
    • Webhooks management, enabling real-time data exchanges.
    • Sockets management, facilitating bi-directional client-server communication.
    • Logs management, crucial for system monitoring and troubleshooting.
    • API events management, keeping a pulse on system communications.

🏁 Getting Started

Before you can get started with Fleetbase, you'll need to make sure you have the following prerequisites:

1. A computer running either Linux, Mac OS, or Windows
2. Docker installed
3. Git installed
4. If you want to try now, the cloud hosted version of Fleetbase available here.

🚦 Use Cases

Fleetbase's comprehensive suite of features and the modular design make it highly versatile, catering to a broad array of applications across different industries. Here are a few use cases:

• Logistics and Supply Chain Management: Fleetbase could be employed by a logistics company to streamline its operations. Real-time tracking provided by FleetOps would help maintain visibility of fleet vehicles and assets at all times. This would ensure timely delivery, reduce operational inefficiencies, and enable proactive management of any logistical issues. Additionally, the order creation and management feature could be used to manage deliveries, pickups, and routing.
• On-demand Delivery Services: On-demand services like food delivery or courier companies could utilize Fleetbase to manage their fleet of delivery agents. The real-time tracking functionality would help to optimize routes and ensure prompt deliveries, while the order creation and management system would efficiently handle incoming orders.
• E-Commerce Platforms: E-commerce businesses could leverage Fleetbase to manage their backend logistics. The Storefront extension would enable seamless online transactions, while FleetOps could manage all aspects of the delivery process, ensuring a smooth shopping experience for the customers.
• Ride-Hailing Services: Fleetbase could be a perfect fit for ride-hailing or car rental services. FleetOps would manage real-time tracking of vehicles, maintaining optimal vehicle utilization, while the API and Webhooks would facilitate integration with mobile apps to provide real-time updates to customers.
• Third-party Logistics (3PL) Provider: A 3PL provider could use Fleetbase for comprehensive management of its services. From real-time tracking of cargo to managing service rates and integration with other vendors in the supply chain, Fleetbase could provide an all-in-one solution.
• Developer Resource Management: Developers building complex, resource-intensive applications could benefit from Fleetbase's Dev Console. API keys and webhook management could streamline the secure interaction between different software components. At the same time, sockets, logs, and API events management tools would assist in maintaining, troubleshooting, and improving the system.
• Public Transportation Systems: City transportation services could use Fleetbase to optimize their bus or subway operations. With FleetOps, they could have real-time tracking of their vehicles, ensuring that schedules are met promptly and delays are handled effectively. Moreover, service rates management could assist in setting and adjusting fares, while the API and Webhooks functionality could integrate with public apps to provide real-time updates to commuters about arrivals, delays, and route changes.
• Fleet Leasing Companies: Fleet leasing companies could employ Fleetbase to manage their vehicle assets and track their status in real time. From managing service rates to ensuring the best utilization of assets, FleetOps could provide a holistic solution. Moreover, the Storefront extension could be used to list available vehicles and manage online reservations seamlessly.
• Emergency Services: Emergency services like ambulance or firefighting departments could use Fleetbase to manage their operations. FleetOps would provide real-time tracking, ensuring that emergency vehicles are dispatched quickly and the fastest routes are chosen. In addition, the API and Webhooks functionality could allow integration with emergency call centers, ensuring a seamless flow of information and a swift response to emergencies.

Remember, these are just a few examples. Given the modular and extensible nature of Fleetbase, it can be customized and scaled to fit many other use cases across different industries.

💾 Installation

Getting Fleetbase up and running on your system using Docker and Docker-compose is straightforward. Please follow the steps below:

Prerequisites

• Ensure that you have Docker and Docker-compose installed on your system. If not, you can download and install them from their respective official websites:
  • Docker
  • Docker Compose
• Clone the Fleetbase repository to your local machine:

  bash git clone https://github.com/fleetbase/fleetbase.git

• Navigate to the cloned repository:

  cd fleetbase

Build and Run Fleetbase

1. Start the Docker daemon: Ensure the Docker daemon is running on your machine. You can either start Docker Desktop or either executed by running:

   sudo systemctl start docker

2. Build the Docker containers: Use Docker Compose to build and run the necessary containers. In the root directory of the Fleetbase repository, run:

   docker-compose up -d

Access Fleetbase

Now that Fleetbase is up and running via Docker you can find the console and the API accessible:

• Fleetbase Console: http://localhost:4200
• Fleetbase API: http://localhost:8000

🧩 Extensions

Fleetbase extensions provide a powerful way to enhance and customize the functionality of Fleetbase to suit your specific needs. They are standalone modules that seamlessly integrate with Fleetbase's frontend and backend, allowing you to extend its capabilities.

What are Fleetbase Extensions?

Fleetbase Extensions are built using both a backend PHP package and a frontend Ember Engine Addon. They are designed to blend seamlessly into the Fleetbase ecosystem, utilizing shared services, utilities, stylesheets, components, and template helpers.

How do Extensions Work?

• Backend: The backend of an extension is developed as a PHP package. This package should utilize the composer package `fleetbase/core-api`, which provides core API functionalities, making it easier to integrate your extension with Fleetbase's backend.
• Engine: The frontend of an extension is built as an Ember Engine Addon. The Addon must require the packages `@fleetbase/ember-core` and `@fleetbase/ember-ui`. The `@fleetbase/ember-core` package provides core services and utilities that help to align your extension with Fleetbase's frontend. The `@fleetbase/ember-ui` package, on the other hand, supplies all the stylesheets, components, and template helpers needed to design a Fleetbase extension that seamlessly matches the look and feel of the Fleetbase UI.

Building a Fleetbase Extension

To create a Fleetbase extension, follow these steps:

• Backend PHP Package Creation: Begin by creating a backend PHP package. Make sure to use the composer package `fleetbase/core-api` to ensure smooth integration with Fleetbase's backend.
• Frontend Ember Engine Addon: Next, you need to create the frontend of the extension using Ember Engine. Be sure to include the `@fleetbase/ember-core` and `@fleetbase/ember-ui` packages. These packages provide necessary services, utilities, and design components for aligning your extension with Fleetbase's UI.
• Integrate Your Extension: Once you have the backend and frontend ready, you can integrate your extension into Fleetbase by installing it via the respective package managers. In the future you will be able to publish your extension to the Fleetbase extensions repository making it available to all instances of Fleetbase with the ability to even sell your extension.

With Fleetbase's modular architecture, you can develop your extensions to solve unique problems, enhance existing functionality, or add entirely new capabilities to your Fleetbase instance. This extensibility allows Fleetbase to adapt and evolve with your growing business needs.

📱 Apps

Fleetbase offers a few open sourced apps which are built on Fleetbase which can be cloned and customized. Every app is built so that the Fleetbase instance can be switched out whether on-premise install or cloud hosted.

• Storefront App: Fleetbase based ecommerce/on-demand app for launching your very own shop or marketplace to Apple or Android playstore.
• Navigator App: Fleetbase based driver app which can be used for drivers to manage and update order, additionally provides real time driver location which can be viewed in the Fleetbase Console.

🛣 Roadmap

1. Install Flow & System Configuration from Console
2. Open Source Extension Repository
3. Inventory and Warehouse Management Extension
4. Freight Forwarder Quote Parser/ System Extension

🪲 Bugs and 💡 Feature Requests

Have a bug or a feature request? Please check the issue tracker and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

📚 Documentation

View and contribute to our Fleetbase Guide's and API Reference

👨‍💻 Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

👥 Community

Get updates on Fleetbase's development and chat with the project maintainers and community members.

• Follow @fleetbase_io on Twitter.
• Read and subscribe to The Official Fleetbase Blog.
• Ask and explore our GitHub Discussions.

See the Releases section of our GitHub project for changelogs for each release version of Fleetbase.

Release announcement posts on the official Fleetbase blog contain summaries of the most noteworthy changes made in each release.

Creators

Ronald A. Richardson- Co-founder & CTO

Github | LinkedIn

Shiv Thakker - Co-founder & CEO

Github | LinkedIn

License & Copyright

Code and documentation copyright 2018–2023 the Fleetbase Authors. Code released under the MIT License.