diff --git a/README.md b/README.md index dcb55e5f..b8e3793d 100644 --- a/README.md +++ b/README.md @@ -1,113 +1,116 @@
-

- - Fleetbase logo - -

-

- Open source logistics infrastructure for developers -
- Explore Fleetbase docs ยป -
-
- Report bug - ยท - Request 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

+
+

+ + Fleetbase logo + +

+

+ Open source logistics infrastructure for developers +
+ Explore Fleetbase docs ยป +
+
+ Report bug + ยท + Request 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

    -
  • ๐Ÿšš FleetOps (Open Source TMS) - End to end transport management system for logistics operations management and overview.
    • -
  • ๐Ÿช Storefront (Open Source App) - Customer app, multi vendor, multi location. Ideal for any last mile delivery or on demand service.
    • -
  • ๐Ÿ’ป Operations (Open Source Console) - Full console to manage all of your packages and custom systems.
    • -
  • ๐Ÿ‘ฉโ€๐Ÿ’ป Developer API & Console - Developer console which provides API usage metrics, event and request logs
    • -
  • ๐Ÿ“ฑ Driver App (Open Source Integrated Driver App - Integrated to TMS. Drivers can manage jobs, tracking and electronic POD.
    • -
  • โš™๏ธ Extensions - Build additional features and extensions right into the console. Offer extensions back to the community.
    • +
  • FleetOps (Open Source TMS) - End to end transport management system for logistics operations management and overview.
    • +
  • Storefront (Open Source App) - Customer app, multi-vendor, multi-location. Ideal for any last-mile delivery or on-demand service.
    • +
  • Operations (Open Source Console) - Full console to manage all of your packages and custom systems.
    • +
  • Developer API & Console - Developer console which provides API usage metrics, event and request logs
    • +
  • Driver App (Open Source Integrated Driver App - Integrated to TMS. Drivers can manage jobs, tracking and electronic POD.
    • +
  • Extensions - Build additional features and extensions right into the console. Offer extensions back to the community.
- -

๐Ÿ’จ 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
    • -
  • A Docker installed
    • -
  • Git installed
    • -
  • Want to try our cloud hosted version of Fleetbase?
    • -
- -

๐Ÿ’ป Installation

-

To install Fleetbase on your computer, follow these steps:

-

Clone the Fleetbase repository using Git:

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

-

Navigate to the Fleetbase directory:

cd fleetbase

-

If you're using npm, run the following command:

npm install

-

If you're using Yarn, run the following command:

yarn install
-

Start the Fleetbase Docker containers:

docker-compose up -d

-

Launch the Fleetbase Console

-

Navigate to the console directory:

cd console

-

Launch the console 

yarn start

- -

๐Ÿ“ˆ Status

-

Build Status -npm version - -

๐Ÿ™‹โ€โ™‚๏ธ 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 contribue 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.

-
- -