mirror of
https://github.com/gradio-app/gradio.git
synced 2025-01-06 10:25:17 +08:00
abad6383df
* docs(CONTRIBUTING): Update with new details * docs(ui): Update with correct details * fix(Error): Fix minor typo * docs: Link to `ui` readme from contributing guide * Update CONTRIBUTING.md Co-authored-by: pngwn <hello@pngwn.io>
99 lines
2.4 KiB
Markdown
99 lines
2.4 KiB
Markdown
# 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)
|
|
|
|
> Note: The below assumes you are in the `ui` directory unless alternative instructions are given.
|
|
|
|
## 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 from the `ui` folder:
|
|
|
|
```bash
|
|
pnpm i
|
|
```
|
|
|
|
This will install the dependencies for all packages within the `ui` folder 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
|
|
cd ui #move back into ui if you haven't already
|
|
pnpm dev
|
|
```
|
|
|
|
## building for production
|
|
|
|
From the `ui` folder run the build.
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
This will create the necessary files in `ui/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:
|
|
|
|
- Format check (`pnpm format:check`)
|
|
- Type check (`pnpm ts:check`)
|
|
- Build as a smoke test (`pnpm build`)
|