# Quick Start

EasyDispatch relies on Postgres DB, Redis and Kafka. Those three components can be started by docker (opens new window) and compose (opens new window) or provisioned seperately. You also should have npm and node (opens new window) for frontend development.

  1. To run easydispatch locally, first install it by:
git clone https://github.com/alibaba/easydispatch.git && cd easydispatch
pip install -e .
  1. Then copy and modify env file from $easydisaptch/etc/dev_env_sample to $easydisaptch/dev.env . Start the database, redis and kafka by docker composer.
docker-compose -f kafka-redis-postgres-compose.yml -p easy up
  1. Open another terminal, populate some sample data and run the frontend:
python -m dispatch.cli database init
python -m dispatch.cli server start --port 8000 dispatch.main:app 
  1. Visit the page at : http://localhost:8000/login

  2. You should a page like this. If not, raise an issue in main repo (opens new window)

login_page

# OS and Environements

We tested it on Ubuntu 20.04 and MacOS, Python 3.7 / 3.8

# Online Demo

We are working on demo...

Last Updated: 6/8/2021, 7:20:03 PM