@an.nguyen2/alice-ui v0.0.8

Welcome to Alice UI

This is a guide on how to install, configure, run, test and deploy this project.

Prerequisites

• You need to have yarn installed on your machine.
• You may need to install cmake (brew install cmake) if you encounter any errors during the installation.
• You need to have either docker (brew cask install docker) or gettext (brew install gettext && brew link --force gettext) installed for generating the local config file.

Installation

• Run yarn install to install the required packages.

Configuration

• Create the configuration files public/config.js follow template in public/config.js.template:

Running the UI

• Run yarn dev to start the App.
• You will see the information about the app and port in the terminal.

Running the mock server for mocking streaming API

• The mock server files is located in src/mock-server
• Run yarn server to start the server.

Formatting the code

• Run yarn lint to check format the code using eslint and prettier.

Testing the project

• Run yarn test to run the tests with a watcher (recommended for development).
• Run yarn test:ci to run the tests only for checking the result (suitable for CI).
• Run docker build -f docker/test.Dockerfile -t test-alice-ui . && docker run -t test-alice-ui to run the tests on docker.