File size: 2,464 Bytes
0ad74ed |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# gradio-ui
This folder contains all of the Gradio UI and component source code.
- [set up](#setup)
- [running the application](#running-the-application)
- [local development](#local-development)
- [building for production](#building-for-production)
- [quality checks](#quality-checks)
- [ci checks](#ci-checks)
## setup
This folder is managed as 'monorepo' a multi-package repository which make dependency management very simple. In order to do this we use `pnpm` as our package manager.
Make sure [`pnpm`](https://pnpm.io/) is installed by [following the installation instructions for your system](https://pnpm.io/installation).
You will also need `node` which you probably already have
## running the application
Install all dependencies:
```bash
pnpm i
```
This will install the dependencies for all packages and link any local packages
## local development
To develop locally, open two terminal tabs from the root of the repository.
Run the python test server, from the root directory:
```bash
cd demo/kitchen_sink
python run.py
```
This will start a development server on port `7860` that the web app is expecting.
Run the web app:
```bash
pnpm dev
```
## building for production
Run the build:
```bash
pnpm build
```
This will create the necessary files in `js/app/public` and also in `gradio/templates/frontend`.
## quality checks
The repos currently has two quality checks that can be run locally and are run in CI.
### formatting
Formatting is handled by [`prettier`](https://prettier.io/) to ensure consistent formatting and prevent style-focused conversations. Formatting failures will fails CI and should be reoslve before merging.
To check formatting:
```bash
pnpm format:check
```
If you have formatting failures then you can run the following command to fix them:
```bash
pnpm format:write
```
### type checking
We use [TypeScript](https://www.typescriptlang.org/) to provide static types to javascript code. These checks are also run in CI.
to typecheck the code:
```bash
pnpm ts:check
```
## ci checks
Currently the following checks are run in CI:
### static checks
- Format check (`pnpm format:check`)
- Build css (`pnpm css`)
- Build client (`pnpm build`)
- Type check (`pnpm ts:check`)
- Unit tests (`pnpm test:run`)
### functional test
```
pip install -r demo/outbreak_forecast/requirements.txt
pnpm exec playwright install chromium
pnpm exec playwright install-deps chromium
pnpm test:browser:full
```
|