Eric Seidel
92 lines
4.7 KiB
Markdown
92 lines
4.7 KiB
Markdown
## Shorebird 🐦
|
|
|
|
Shorebird is now 1.0! 🎉
|
|
https://shorebird.dev/blogs/1.0/
|
|
|
|
[](https://discord.gg/shorebird) <a href="https://www.producthunt.com/posts/shorebird-code-push?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-shorebird-code-push" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=449946&theme=neutral" alt="Shorebird Code Push - Flutter over the air updates | Product Hunt" style="width: 128px; height: 27px;" width="128" height="27" /></a>
|
|
|
|
[](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml)
|
|
[](https://github.com/shorebirdtech/shorebird/actions/workflows/e2e.yaml)
|
|
[](https://codecov.io/gh/shorebirdtech/shorebird)
|
|
[](./LICENSE-MIT)
|
|
[](./LICENSE-APACHE)
|
|
|
|
## Getting Started
|
|
|
|
Visit https://docs.shorebird.dev to get started.
|
|
|
|
## Packages
|
|
|
|
This repository is a monorepo containing the following packages:
|
|
|
|
| Package | Description |
|
|
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
| [shorebird_cli](packages/shorebird_cli/README.md) | Command-line which allows developers to interact with various Shorebird services |
|
|
| [shorebird_code_push_client](packages/shorebird_code_push_client/README.md) | Dart library which allows Dart applications to interact with the ShoreBird CodePush API |
|
|
| [shorebird_code_push_protocol](packages/shorebird_code_push_protocol/README.md) | Dart library which contains common interfaces used by Shorebird CodePush |
|
|
| [artifact_proxy](packages/artifact_proxy/README.md) | Dart server which supports intercepting and proxying Flutter artifact requests. |
|
|
| [discord_gcp_alerts](packages/discord_gcp_alerts/README.md) | Dart server which forwards GCP alerts to Discord |
|
|
| [jwt](packages/jwt/README.md) | Dart library for verifying Json Web Tokens |
|
|
| [redis_client](packages/redis_client/README.md) | Dart library for interacting with Redis |
|
|
| [scoped](packages/scoped/README.md) | A simple dependency injection library built on Zones |
|
|
|
|
For more information, please refer to the documentation for each package.
|
|
|
|
## Contributing
|
|
|
|
If you're interested in contributing, please join us on
|
|
[Discord](https://discord.gg/shorebird).
|
|
|
|
### Environment setup
|
|
|
|
Working on Shorebird requires Dart.
|
|
|
|
`./scripts/bootstrap.sh` will run `pub get` all packages in the repository.
|
|
|
|
### Running tests
|
|
|
|
We don't yet have a script to run tests locally. For now, we recommend using
|
|
`very_good test -r` in the packages directory to run all shorebird tests.
|
|
|
|
(If you run it in the root, it will find packages in bin/cache/flutter and try
|
|
to run tests there, some of which will fail.)
|
|
|
|
To generate a coverage report install `lcov`:
|
|
|
|
```
|
|
brew install lcov
|
|
```
|
|
|
|
Then run tests with the `--coverage` flag:
|
|
|
|
```
|
|
very_good test -r --coverage
|
|
genhtml coverage/lcov.info -o coverage
|
|
```
|
|
|
|
You can view the generated coverage report via:
|
|
|
|
```
|
|
open coverage/index.html
|
|
```
|
|
|
|
### Tracking coverage
|
|
|
|
The following command will generate a coverage report for the Dart packages:
|
|
|
|
```bash
|
|
dart test --coverage=coverage && dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info --packages=.dart_tool/package_config.json --check-ignore
|
|
```
|
|
|
|
Coverage reports are uploaded to [Codecov](https://app.codecov.io/gh/shorebirdtech/shorebird).
|
|
|
|
## License
|
|
|
|
Shorebird projects are licensed for use under either Apache License, Version 2.0
|
|
(LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) MIT license
|
|
(LICENSE-MIT or http://opensource.org/licenses/MIT) at your option.
|
|
|
|
See our license philosophy for more information on why we license files this
|
|
way:
|
|
https://github.com/shorebirdtech/handbook/blob/main/engineering.md#licensing-philosophy
|