Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added github CI actions #28

Merged
merged 10 commits into from
Dec 28, 2021
49 changes: 49 additions & 0 deletions .github/workflows/flutter-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Flutter CI

on:
push:
branches: [master, development]
pull_request:
branches: [master, development]

jobs:
test:
strategy:
matrix:
platform: [windows-latest, ubuntu-latest, macos-latest]
runs-on: ${{matrix.platform}}
steps:
- uses: actions/checkout@v1
- uses: actions/setup-java@v1
with:
java-version: "12.x"
- uses: subosito/flutter-action@v1
with:
flutter-version: '2.5.0'
- run: flutter pub get
- run: flutter format --set-exit-if-changed .
- run: flutter analyze .
# - run: flutter test

build:
strategy:
matrix:
platform: [windows-latest, macos-latest, ubuntu-latest]
runs-on: ${{matrix.platform}}
steps:
- uses: actions/checkout@v1
- uses: actions/setup-java@v1
with:
java-version: "12.x"
- uses: subosito/flutter-action@v1
with:
flutter-version: '2.5.0'
- run: flutter pub get
- run: flutter format --set-exit-if-changed .
- run: flutter analyze .
# - run: flutter test
# - run: flutter build apk
# - uses: actions/upload-artifact@v1
# with:
# name: release-apk
# path: build/app/outputs/apk/release/app-release.apk
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Beacon
[![CI](https://github.com/devansh12b2/beacon/actions/workflows/flutter-ci.yml/badge.svg)](https://github.com/devansh12b2/beacon/actions/workflows/flutter-ci.yml/)

## About the Project

This project is a flutter build native interface to ease the group travelling (or hiking). By using this, the group leader would be able to share his location with the entire crew, and in case if someone loses contact with the group, he can quickly get in the right place by following the beacon.
This project is a flutter build native interface to ease the group travelling (or hiking). By using this, the group leader would be able to share his location with the entire crew, and in case if someone loses contact with the group, he can quickly get in the right place by following the beacon.

## Getting Started

Expand All @@ -28,15 +29,15 @@ beacon/lib/
├── components/ # Shared Components such as dialog boxes, button, and other shared widgets
├── enums/ # enum files
| └── view_state.dart # defines view states i.e Idle, Busy, Error
├── models/ # model classes: beacon, location, landmark, user
├── models/ # model classes: beacon, location, landmark, user
├── queries/ # includes all graphql query strings
├── services/ # services
| ├── database_mutation_function.dart/ # Graphql Queries implementations
| ├── navigation_service.dart/ # All required navigation services
| └── ... # all config files
├── utilities/ # Utilities that includes constants file
├── views/ # Views/UI layer
| ├── auth_screen.dart
| ├── auth_screen.dart
| ├── base_view.dart
| ├── hike_screen.dart
| ├── home.dart
Expand All @@ -51,7 +52,7 @@ beacon/lib/

<img src="screenshots/1.jpg" width="24%" /> <img src="screenshots/2.jpg" width="24%"/> <img src="screenshots/3.jpg" width="24%"/> <img src="screenshots/4.jpg" width="24%"/>

## Contributing
## Contributing

Whether you have some feauture requests/ideas, code improvements, refactoring, performance improvements, help is always Welcome. The more is done, better it gets.

Expand All @@ -63,4 +64,4 @@ If you found any bugs, consider opening an [issue](https://github.com/CCExtracto

We would love to hear from you! You may join gsoc-beacon channel of CCExtractor community through slack:

[![Slack](https://img.shields.io/badge/chat-on_slack-purple.svg?style=for-the-badge&logo=slack)](https://ccextractor.org/public/general/support/)
[![Slack](https://img.shields.io/badge/chat-on_slack-purple.svg?style=for-the-badge&logo=slack)](https://ccextractor.org/public/general/support/)