README.md

For Developers

Setup

• Install rust

curl https://sh.rustup.rs -sSf | sh

• Install nodejs

curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash
sudo apt-get install -y nodejs
node -v

• Install yarn

sudo npm install --global yarn

• Run yarn install
• Run yarn setup:ui

Running the Dev Server

• To start the development server along with the tauri instance run yarn tauri dev. You will see an application window popup.

• To start only the NextJS development server run yarn dev. Then go to localhost:1420 to view the website.

Building the Application

• Run yarn tauri build to build the application.

• To build for linux you may need to install the following packages

sudo apt install libwebkit2gtk-4.0-dev \
    build-essential \
    curl \
    wget \
    libssl-dev \
    libgtk-3-dev \
    libayatana-appindicator3-dev \
    librsvg2-dev \
    pkg-config \
    libssl-dev \
    libdbus-1-dev \

• To build for windows you'll need to install rust for windows and node.js for windows
  • Once you have node install you might have to run corepack enable to activate yarn
• You can specify the target platform when building the application by running yarn tauri build --target universal-apple-darwin
  • Use rustup target list to get a list of targets

Testing

• Run yarn test:e2e to run unit tests with Playwright
  • API mocks uses msw
• Run yarn test:unit to run unit tests with Vitest
  • Component testing uses react-testing-library