Skip to content

Latest commit

 

History

History
146 lines (95 loc) · 3.31 KB

DEVELOPMENT.md

File metadata and controls

146 lines (95 loc) · 3.31 KB

Yatai development guide

Yatai uses Golang for its backend and react/typescript for the frontend web UI. Download the source code:

git clone https://github.com/bentoml/yatai.git

Prerequisites

Yatai Web UI

  1. NodeJS version 14.16.1 or above

    For Apple computer with M1 chip, please install nodejs version >=14.17.1

    • We recommend installing NodeJS using nvm which allows developers to quickly install and use different versions of node:

      # Install NVM
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash

nvm install 14.17.1
nvm alias default 14.17.1

  2. Yarn package manager (optional)

    Yatai uses yarn package manager to run varies of Web UI related ops in the Makefile.

    npm install -g yarn

Yatai Server

  1. PostgreSQL

    A local PostgreSQL database is required to set up a local development environment. Follow the official installation guide for your system here: https://www.postgresql.org/download/

    For mac users, install Postgres with homebrew:

    brew install postgresql

    After installation, create a database for Yatai

    createdb yatai

  2. Golang

    Yatai uses golang for its backend. Install Golang for your system following the official installation guide here: https://go.dev/doc/install

    For Mac users, install Golang with homebrew:

    brew install go

Install dependencies

Yatai WebUI

Yatai uses yarn to manage its front-end dependencies. Run the make command:

make fe-deps

Alternatively navigate to the dashboard directory and run yarn command:

cd dasboard
yarn

Yatai server

Yatai uses go command to download the dependency packages. Run the make command:

make be-deps

Alternatively to run the download command directly:

go mod download

Nix

There is a nix folder which enable developers the ability to use nix to startup Yatai development workflow. However, this is for advanced user only. Use with precaution!

Run development server

  1. Generate Yatai config file

    Create yatai-config.dev.yaml file that bases on the yatai-config.sample.yaml template and update the postgrsql section in the configuration file.

    An example for a local yatai-config.dev.yaml (nix-shell compatible):

        in_cluster: false

    server:
    enable_https: false
    port: 7777
    session_secret_key:
    migration_dir: ./api-server/db/migrations

    postgresql:
    host: localhost
    port: 5432
    user: postgres
    password: ''
    database: yatai

    initialization_token: 12345

  2. Spin up minikube:

minikube start --cpus 4 --memory 4096

  1. Run sudo minikube tunnel to enable ingress controller.

  2. Run make command that start the development server for both Yatai UI and Yatai server.

    make yatai-dev

    Visit http://localhost:7777 to view the Yatai Web UI

    Visit http://localhost:7777/swagger to view Yatai server’s API definitions.

    Visit http://localhost:3000/setup?token=12345 to initially setup a dev credentials.