Karrio Dashboard
Karrio Dashboard is a browser-based logistics and shipping app for karrio.
Getting Started
Using a Karrio Dashboard Release
If you just want to try Karrio out, check out the karrio/dashboard Docker Image to give it a whirl.
Building and Running Karrio Dashboard
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
- Node.js v14+
- A running instance of karrio server.
Installing
Clone the repository
git clone https://github.com/karrioapi/karrio-dashboard.git
cd karrio-dashboard
npm install
Configuration
Use the following environment variables to configure the dashboard:
-
NEXT_PUBLIC_KARRIO_API_URL
(required) - URL of a running instance of karrio server. If you are running karrio-server locally with the default settings, setNEXT_PUBLIC_KARRIO_API_URL
to:http://localhost:5002
. -
JWT_SECRET
(required) - A secret to use for JWT key generation - you should set this explicitly. -
NEXTAUTH_URL
(required) - The URL of your dashboard to restrict the authentication host to your instance. If you are running the dashboard locally, setNEXTAUTH_URL
to:http://localhost:3000
.
Development
Start the development server
npm run dev
Karrio Dashboard should now be running at http://localhost:3000.
Production
Build the application bundle
npm run build
Resources
License
This project is licensed under the terms of the Apache 2
license.
See the LICENSE file for license rights and limitations.
Any other questions, mail us at [email protected] We’d love to meet you!