Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thecodexhub committed May 22, 2021
1 parent 73e3170 commit 98bafb4
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Expand Up @@ -50,6 +50,32 @@ Ths project has several features:
- Covid case data are taken from [here](https://api.covid19api.com/summary).
- News are fetched from [newsapi.org](https://newsapi.org/).

## Running the project

To run this project, some configuration steps are required.

- Create your own API key from [newsapi.org](https://newsapi.org/).
- Create a new file named `api_key.dart` inside the `lib` folder.
- Paste the following line with your API key.
```Dart
const String NEWS_API_KEY = 'YOUR_API_KEY';
```

Learn Test Driven Development and Clean Architecture

- [https://resocoder.com/flutter-clean-architecture-tdd](https://resocoder.com/flutter-clean-architecture-tdd/)

Additional good tutorials and documentations that might help

- Internationalizing Flutter apps: [https://flutter.dev/docs/development/accessibility-and-localization/internationalization](https://flutter.dev/docs/development/accessibility-and-localization/internationalization)
- CI & CD with Flutter: [https://flutter.dev/docs/deployment/cd](https://flutter.dev/docs/deployment/cd)
- Flutter GitHub Actions - Automate Your Workflow: [https://github.com/marketplace/actions/flutter-action](https://github.com/marketplace/actions/flutter-action)

## TODO

- [ ] Full test coverage including Integration Test
- [ ] Improve Documentation

## License

The project is released under the [MIT License](http://www.opensource.org/licenses/mit-license.php). The license can be found [here](LICENSE).
Expand All @@ -59,3 +85,5 @@ The project is released under the [MIT License](http://www.opensource.org/licens
For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.

## If you like this repository then kindly give it a star ⭐

0 comments on commit 98bafb4

Please sign in to comment.