Skip to main content

Developing Karrio

Documentation for developers contributing to the Karrio code base.

Prerequisites

Server

The following steps need to be performed inside a terminal window (Windows user may prefer to use the Windows WSL).

Clone the repository:

git clone https://github.com/karrioapi/karrio.git
cd karrio

Database

Setup a PostgreSQL database for the application.

docker-compose up -d db

Installation using Python

  • Setup Python environment with the dependencies:
. ./scripts/setup-server-env.sh
  • Apply database migrations, collect static assets:
karrio migrate
karrio collectstatic --noinput
  • Finally, create yourself an admin account:
karrio createsuperuser
  • Start the server:
karrio runserver 0.0.0.0:5002
caution

On windows, use 0.0.0.0:5002 instead of localhost:5002

Dashboard

git clone https://github.com/karrioapi/karrio-dashboard.git
cd karrio-dashboard
  • Install node dependencies:
npm install
  • Setup environment variables:
cp .env.sample .env
caution

On windows set up: NEXT_PUBLIC_KARRIO_API_URL=http://localhost:5002

  • Start the dashboard:
npm run dev

Troubleshooting

Make sure Docker and Docker Compose work before attempting to run Karrio. We won't be able to assist with your Docker installation.

Make sure you've read the warning about Windows 10 Home. Windows versions before Windows 10 are not officially supported.

If you encounter other problems, see Support.