Skip to content

fleetbase/fleetbase

Repository files navigation

Fleetbase logo

Modular logistics and supply chain operating system
Documentation · Cloud Version · API Status · Book a Demo · Discord


What is Fleetbase?

Fleetbase is a modular logistics and supply chain operating system designed to streamline management, planning, optimization, and operational control across various sectors of the supply chain industry.

Fleetbase Console

Quickstart

git clone git@github.com:fleetbase/fleetbase.git  
cd fleetbase  
docker-compose up -d  
docker exec -ti fleetbase-application-1 bash  
sh deploy.sh

📖 Table of contents

📦 Features

  • Extensible: Build installable extensions and additional functionality directly into the OS via modular architecture.
  • Developer Friendly: RESTful API, socket, and webhooks to seamlessly integrate with external systems or develop custom applications.
  • Native Apps: Collection of open-source and native apps designed for operations and customer facing.
  • Collaboration: Dedicated chat and comments system for collaboration across your organization.
  • Security: Secure data encryption, adherence to industry-standard security practices, and a comprehensive dynamic Identity and Access Management (IAM) system.
  • Telematics: Integrate and connect to hardware devices and sensors to provide more feedback and visibility into operations.
  • Internationalized: Translate into multiple languages to accommodate diverse user bases and global operations.
  • Framework: PHP core built around logistics and supply chain abstractions to streamline extension development.
  • Dynamic: Configurable rules, flows and logic to enable automation and customization.
  • UI/UX: Clean, responsive user-friendly interface for efficient management and operations from desktop or mobile.
  • Dashboards: Create custom dashboards and widgets to get full visibility into operations.
  • Scalability: Uninterrupted growth with scalable infrastructure and design, capable of handling increasing data volume and user demand as your business expands.
  • Continuous Improvements: Commitment to continuous improvement, providing regular updates that seamlessly introduce optimizations, new features, and overall enhancements to the OS.
  • Open Source: Deploy it either on-premise or in the cloud according to your organization's needs and preferences.

💾 Install

Getting up and running with Fleetbase via Docker is the quickest and most straightforward way. If you’d like to use Fleetbase without docker read the full install guide in the Fleetbase documentation.

Make sure you have both the latest versions of docker and docker-compose installed on your system.

git clone git@github.com:fleetbase/fleetbase.git  
cd fleetbase  
docker-compose up -d  
docker exec -ti fleetbase-application-1 bash  
sh deploy.sh

Accessing Fleetbase

Once successfully installed and running you can then access the Fleetbase console on port 4200 and the API will be accessible from port 8000.

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

Additional Configurations

CORS: If you’re installing directly on a server you may need to add your IP address or domain to the api/config/cors.php file in the allowed_hosts array.

Routing: Fleetbase ships with its own OSRM server hosted at routing.fleetbase.io but you’re able to use your own or any other OSRM compatible server. You can modify this in the console/environments directory by modifying the env file of the environment you’re deploying and setting the OSRM_HOST to the OSRM server for Fleetbase to use.

Services: There are a few environment variables which need to be set for Fleetbase to function with full features. If you’re deploying with docker then it’s easiest to just create a docker-compose.override.yml and supply the environment variables in this file.

version: “3.8”
services:  
  application:  
    environment:  
      MAIL_MAILER: (ses, smtp, mailgun, postmark, sendgrid)
      OSRM_HOST: https://routing.fleetbase.io
      IPINFO_API_KEY:
      GOOGLE_MAPS_API_KEY:  
      GOOGLE_MAPS_LOCALE: us
      TWILIO_SID:  
      TWILIO_TOKEN:
      TWILIO_FROM:
      CONSOLE_HOST: http://localhost:4200

You can learn more about full installation, and configuration in the official documentation.

🛣️ Roadmap

  1. Extensions Registry and Marketplace ~ Allows users to publish and sell installable extensions on Fleetbase instances.
  2. Inventory and Warehouse Management ~ Pallet will be Fleetbase’s first official extension for WMS & Inventory.
  3. Customer Facing Views ~ Extensions will be able to create public/customer facing views tracking and management from outside of the console UI.
  4. Binary Builds ~ Run Fleetbase from a single binary.
  5. Fleetbase CLI ~ Official CLI for publishing and managing extensions, as well as scaffolding extensions.
  6. Fleetbase for Desktop ~ Desktop builds for OSX and Windows.
  7. Custom Maps and Routing Engines ~ Feature to enable easy integrations with custom maps and routing engines like Google Maps or Mapbox etc…

🪲 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.

👨‍💻 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.