# @an.nguyen2/alice-ui

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

Latest version **0.0.8** (published 2023-09-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @an.nguyen2/alice-ui
pnpm add @an.nguyen2/alice-ui
yarn add @an.nguyen2/alice-ui
bun add @an.nguyen2/alice-ui
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2023-09-20 |
| First published | 2023-09-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 11 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | an.nguyen2 |

## Links

- npm: https://www.npmjs.com/package/@an.nguyen2/alice-ui
- npm.io page: https://npm.io/package/@an.nguyen2/alice-ui

## Dependencies (11)

- [ky](https://npm.io/package/ky.md) 0.33.3
- [nanoid](https://npm.io/package/nanoid.md) ^4.0.2
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.1.1
- [rehype-raw](https://npm.io/package/rehype-raw.md) ^7.0.0
- [deep-freeze](https://npm.io/package/deep-freeze.md) ^0.0.1
- [@mui/material](https://npm.io/package/@mui/material.md) 5.14.5
- [@emotion/react](https://npm.io/package/@emotion/react.md) ^11.11.1
- [react-markdown](https://npm.io/package/react-markdown.md) 8.0.7
- [@emotion/styled](https://npm.io/package/@emotion/styled.md) ^11.11.0
- [react-hook-form](https://npm.io/package/react-hook-form.md) 7.45.4
- [@mui/icons-material](https://npm.io/package/@mui/icons-material.md) 5.14.3

## Recent versions

- 0.0.8 (latest) — 2023-09-20
- 0.0.7 — 2023-09-20

## README

# 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.

---
_Source: https://npm.io/package/@an.nguyen2/alice-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._