diff --git a/README.md b/README.md index 6b999b78..6cac05b2 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,247 @@ -
-
-

+

+

- Fleetbase logo + Fleetbase logo

- Open source logistics infrastructure for developers + Open Source Logistics & Supply Chain Platform and Infrastructure
- Explore Fleetbase docs » + Fleetbase Documentation →

- Report bug + Report an Issue · - Request feature + API Reference + · + Guides + · + Request a Feature · Blog

-

- - ⭐ Overview -

-

- Open-source logistics infrastructure, Fleetbase was built for logistics companies and developers to help implement end to end logistics systems whilst preventing long development time and high costs. Build and scale your logistics technology stack without having to start from scratch. Fleetbase allows you to have full control with an end to end logistics platform straight out of the box. -

-

- - 📖 Table of contents -

- -

What's included

- -

Getting Started

-

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

-
    -
  • A computer running Linux or macOS
    • -
  • Docker installed
    • -
  • Git installed
    • -
  • Cloud hosted version of Fleetbase available here.
    • -
- -

Installation

-

To install Fleetbase on your computer, follow these steps:

-
    -
  1. Clone the Fleetbase repository using Git: git clone https://github.com/fleetbase/fleetbase.git
    2. -
  2. Navigate to the Fleetbase directory: cd fleetbase
    3. -
  3. If you're using npm, run: npm install
    4. -
  4. If you're using Yarn, run: yarn install
    5. -
  5. Start the Fleetbase Docker containers: docker-compose up -d
    6. -
- -

Status

-

Build Status -npm version

+
+
+ +# ⭐️ 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](#whats-included) + - [Getting Started](#getting-started) + - [Installation](#installation) + - [Extensions](#extensions) + - [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. +
  2. Docker installed
    3. +
  3. Git installed
    4. +
  4. If you want to try now, the cloud hosted version of Fleetbase available here.
    5. +
+ +# 🚦 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. +
  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
    +
    3. +
+ +### 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. + +# 🛣 Roadmap + +
    +
  1. Install Flow & System Configuration from Console
    2. +
  2. Open Source Extension Repository
    3. +
  3. Inventory and Warehouse Management Extension
    4. +
  4. Freight Forwarder Quote Parser/ System Extension
    5. +
+ +# 🪲 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. -

🙋‍♂️ 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 System Guides 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.