Felix Angelov
71 lines
3.5 KiB
Markdown
71 lines
3.5 KiB
Markdown
## Shorebird 🐦
|
|
|
|
[](https://discord.gg/9hKJcWGcaB)
|
|
|
|
[](https://github.com/shorebirdtech/shorebird/actions/workflows/main.yaml)
|
|
[](./LICENSE-MIT)
|
|
[](./LICENSE-APACHE)
|
|
|
|
Home of the Shorebird Tools
|
|
|
|
## Status
|
|
|
|
We're in the process of converting the quick demos written by one person, into a
|
|
multi-contributor project usable by others. Previous demo code can be found at:
|
|
https://github.com/shorebirdtech/old_repo
|
|
|
|
## Getting Started
|
|
|
|
Refer to [shorebird/install](https://github.com/shorebirdtech/install) for installation instructions.
|
|
|
|
## 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 |
|
|
| [jwt](packages/jwt/README.md) | Dart library for verifying Json Web Tokens |
|
|
| [updater](updater/README.md) | Rust library which handles the CodePush logic and does the real update work |
|
|
|
|
For more information, please refer to the documentation for each package.
|
|
|
|
**❗️ Note: This project is under heavy development. Things will change frequently and none of the code is ready for production use. We will do our best to keep the documentation up-to-date.**
|
|
|
|
## Contributing
|
|
|
|
If you're interested in contributing, please join us on
|
|
[Discord](https://discord.gg/9hKJcWGcaB).
|
|
|
|
### Environment setup
|
|
|
|
Working on Shorebird requires Dart and Rust.
|
|
|
|
We currently assume the Dart from the Flutter SDK on the 'stable' channel. Due
|
|
to the way the Dart compiler works, Shorebird requires an exact version of
|
|
Flutter/Dart to operate correctly today.
|
|
|
|
We currently assume Rust 1.67.0 or later, although the code is unlikely to be
|
|
sensitive to the exact version of Rust.
|
|
|
|
Once both are installed, `./scripts/bootstrap.sh` will run `pub get`
|
|
and `cargo check` for all packages in the repository.
|
|
|
|
### Running tests
|
|
|
|
We don't yet have a script to run tests locally. For now, you can run tests
|
|
manually by running `cargo test` in a Rust package directory or `dart test` in
|
|
a Dart package directory.
|
|
|
|
## 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
|