Fleetbase logo

Open Source Logistics & Supply Chain Platform and Infrastructure
Fleetbase Documentation →

Report an Issue · API Reference · Guides · Request a Feature · Blog · API Status · Discord


# ⭐️ Overview Fleetbase is an open-source platform designed for the efficient management and orchestration of logistics and supply chain operations. It serves as both a powerful operational tool for businesses and a flexible foundation for developers. The platform's core is built around a collection of "extensions," which create a customizable framework capable of meeting a wide range of supply chain and logistics requirements. Each extension in Fleetbase is purposefully engineered to fulfill specific roles within the supply chain and logistics ecosystem. Users have the freedom to create their own extensions, expanding the platform's ecosystem and ensuring its adaptability to various use cases. This extensible nature keeps Fleetbase at the forefront of addressing diverse logistical and supply chain needs now and in the future.

Fleetbase Console

# 📖 Table of contents - [What's Included](#-whats-included) - [Getting Started](#-getting-started) - [Use Cases](#-use-cases) - [Installation](#-installation) - [Extensions](#-extensions) - [Apps](#-apps) - [Roadmap](#-roadmap) - [Bugs and Feature Requests](#-bugs-and--feature-requests) - [Documentation](#-documentation) - [Contributing](#-contributing) - [Community](#-community) - [Creators](#-creators) - [License & Copyright](#-license-and-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: # 🏁 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: 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 ### 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: # 🧩 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? ### Building a Fleetbase Extension To create a Fleetbase extension, follow these steps: 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. # 🛣 Roadmap
  1. Install Flow & System Configuration from Console
  2. Open Source Extension Repository
  3. 🌎 Internationalize
  4. Inventory and Warehouse Management Extension
  5. 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 by joining our Discord.

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

Ron Image

Github | LinkedIn

Shiv Thakker - Co-founder & CEO

Shiv Image

Github | LinkedIn

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