Skip to main content

Start with Local Source Code

Prerequisites​

info

Before installing Xpert, make sure your machine meets the following minimum system requirements:

  • CPU >= 2 Core
  • RAM >= 4 GiB

Clone Xpert​

git clone https://github.com/xpert-ai/xpert.git
cd xpert

Before enabling business services, we need to first deploy PostgreSQL / Redis (if not locally available). We can start them with the following commands:

cd docker
cp .env.example .env
docker compose -f docker-compose.dev.yml up -d

Start Server and Webapp​

Go to the project root directory:

  • Install NodeJs LTS version or later, e.g. 18.x.

  • Install Yarn (if you don't have it) with npm i -g yarn.

  • Install NPM packages and bootstrap solution using the command yarn bootstrap.

  • Copy .env.local file into .env and adjust settings in the file which is used in local runs.

  • Run both API and UI with a single command: yarn start, or run them separately with yarn start:api and yarn start:cloud.

  • Open XpertAI UI on http://localhost:4200 in your browser (API runs on http://localhost:3000/api).

  • Onboarding...

  • Enjoy!

Hot reload​

If you want automatically restarting the node application when file changes in the directory are detected, please use the follow two commands to start servers:

  • yarn start:api:dev
  • yarn start:cloud

With olap engine​

If you wang use the Xpert data analysis platform with olap engine, please run the command:

  • Install java runtime and maven.
  • yarn start:olap