https://github.com/rust-gcc/bottleboard
Where we bottle all the testsuite results together
https://github.com/rust-gcc/bottleboard
hacktoberfest
Last synced: about 1 year ago
JSON representation
Where we bottle all the testsuite results together
- Host: GitHub
- URL: https://github.com/rust-gcc/bottleboard
- Owner: Rust-GCC
- License: apache-2.0
- Created: 2022-05-20T09:07:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-06T12:24:32.000Z (almost 3 years ago)
- Last Synced: 2025-05-15T23:42:54.034Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Rust
- Homepage:
- Size: 114 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# bottleboard
The dashboard where we bottle all the testsuite results together :)
## Project architecture
### `bottlecache`
REST API exposing test-suite results through various endpoints and caching that
data.
#### endpoints
* `/api/testsuites`: List of testsuites for which results are stored
* `/api/testsuites/`: List of testsuite results for that testsuite
* `/api/testsuites//`: Testsuite result for that specific date
### `dashboard`
Front-end of the dashboard. Web Assembly app responsible for performing API calls
to the cache backend and displaying them properly.
### `common`
Set of common types to use in the front-end and back-end at the same time.
## Using/Deploying locally
You can run both the cache and front-end on the same machine locally. This makes
it really easy to test your changes.
First, deploy the cache:
```
# cd bottlecache
# cargo run -- --token
```
The github token access is required.
The API is available on port 8000 of your local machine.
Then, deploy the frontend:
```
# cd dashboard
# trunk serve --open
```
This will open the application on your browser. By default, the API's URL is
your local machine.