-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ui): add contributing markdown (#2708)
* feat(ui): add contributing markdown * update README.md
- Loading branch information
Showing
1 changed file
with
32 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,34 @@ | ||
# Tabby UI | ||
|
||
Run `yarn dev` to start the development server, and use `TABBY_FRONTEND_URI=localhost:3000 cargo ...` to start tabby server with the development frontend. | ||
## 🤝 Contribuing | ||
|
||
### Local Setup | ||
Full guide at [CONTRIBUTING.md](https://github.com/TabbyML/tabby/blob/main/CONTRIBUTING.md#local-setup) | ||
|
||
### Running | ||
During local development, we use Caddy to orchestrate Tabby-UI and local Tabby. We run both the Tabby-UI server and the local Tabby server simultaneously, using Caddy to forward frontend and backend requests to their respective servers, reducing the need for host and port configuration and taking advantage of the hot-reload feature of tabby-ui. | ||
The Caddy configuration file is located [here](https://github.com/TabbyML/tabby/blob/main/ee/tabby-webserver/development/Caddyfile). | ||
|
||
Regarding the Tabby binary in production distribution, we do not start the tabby-ui server and Caddy server. Instead, tabby-ui is solely built and outputs static assets. Routing is configured within Tabby to distribute the static assets produced by tabby-ui. | ||
|
||
#### 1. Start the development frontend server | ||
|
||
``` | ||
cd tabby/ee/tabby-ui | ||
pnpm dev | ||
``` | ||
|
||
#### 2. Start the development backend server | ||
|
||
``` | ||
cargo run serve --port 8081 | ||
``` | ||
|
||
#### 3.Start the caddy server | ||
|
||
``` | ||
make caddy | ||
``` | ||
|
||
#### 4. Start hacking | ||
Now, you can open `http://localhost:8080` to see the tabby webserver! |