|
1 | | -# Ht Email Repository |
2 | | - |
3 | | -[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] |
4 | | -[](https://github.com/felangel/mason) |
5 | | -[![License: MIT][license_badge]][license_link] |
6 | | - |
7 | | -A Very Good Project created by Very Good CLI. |
8 | | - |
9 | | -## Installation 💻 |
10 | | - |
11 | | -**❗ In order to start using Ht Email Repository you must have the [Dart SDK][dart_install_link] installed on your machine.** |
12 | | - |
13 | | -Install via `dart pub add`: |
14 | | - |
15 | | -```sh |
16 | | -dart pub add ht_email_repository |
17 | | -``` |
18 | | - |
19 | | ---- |
20 | | - |
21 | | -## Continuous Integration 🤖 |
22 | | - |
23 | | -Ht Email Repository comes with a built-in [GitHub Actions workflow][github_actions_link] powered by [Very Good Workflows][very_good_workflows_link] but you can also add your preferred CI/CD solution. |
24 | | - |
25 | | -Out of the box, on each pull request and push, the CI `formats`, `lints`, and `tests` the code. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses [Very Good Analysis][very_good_analysis_link] for a strict set of analysis options used by our team. Code coverage is enforced using the [Very Good Workflows][very_good_coverage_link]. |
26 | | - |
27 | | ---- |
28 | | - |
29 | | -## Running Tests 🧪 |
30 | | - |
31 | | -To run all unit tests: |
32 | | - |
33 | | -```sh |
34 | | -dart pub global activate coverage 1.2.0 |
35 | | -dart test --coverage=coverage |
36 | | -dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info |
37 | | -``` |
38 | | - |
39 | | -To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov). |
40 | | - |
41 | | -```sh |
42 | | -# Generate Coverage Report |
43 | | -genhtml coverage/lcov.info -o coverage/ |
44 | | - |
45 | | -# Open Coverage Report |
46 | | -open coverage/index.html |
47 | | -``` |
48 | | - |
49 | | -[dart_install_link]: https://dart.dev/get-dart |
50 | | -[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions |
51 | | -[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg |
52 | | -[license_link]: https://opensource.org/licenses/MIT |
53 | | -[logo_black]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_black.png#gh-light-mode-only |
54 | | -[logo_white]: https://raw.githubusercontent.com/VGVentures/very_good_brand/main/styles/README/vgv_logo_white.png#gh-dark-mode-only |
55 | | -[mason_link]: https://github.com/felangel/mason |
56 | | -[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg |
57 | | -[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis |
58 | | -[very_good_coverage_link]: https://github.com/marketplace/actions/very-good-coverage |
59 | | -[very_good_ventures_link]: https://verygood.ventures |
60 | | -[very_good_ventures_link_light]: https://verygood.ventures#gh-light-mode-only |
61 | | -[very_good_ventures_link_dark]: https://verygood.ventures#gh-dark-mode-only |
62 | | -[very_good_workflows_link]: https://github.com/VeryGoodOpenSource/very_good_workflows |
0 commit comments