Skip to content

Commit

Permalink
Merge pull request #11 from futuredapp/feature/refactor-minors
Browse files Browse the repository at this point in the history
Clean readme files and unnecessary workflows
  • Loading branch information
davidkocnar authored Jul 10, 2023
2 parents 522ad50 + 989fa20 commit 4334b41
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 125 deletions.
10 changes: 2 additions & 8 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
## Setting up workflows

### 1. Following secrets are needed by implemented workflows. All of them are available
in organization level secrets, you just have to grant access to particular app:
### 1. Following secrets are needed by implemented GitHub Actions workflows:

1. `DANGER_GITHUB_API_TOKEN`
2. `APPCENTER_API_TOKEN`

### 2. Configure workflow .yml files

For each workflow configuration file, configure all environment variables marked with `TODO` comment.
`DANGER_GITHUB_API_TOKEN`
21 changes: 0 additions & 21 deletions .github/workflows/enterprise.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ jobs:
enterprise:
name: Enterprise build
runs-on: [ubuntu-latest]
env:
APPCENTER_APP_NAME: futured/Futured-Dev-Academy
# Add additional AppCenter user groups separated by semicolon, if applicable, eg. "Collaborators;Partners"
APPCENTER_GROUPS: Collaborators
EXCLUDE_APK_FILTER: .*unaligned.apk\|.*Test.*.apk
steps:
- uses: actions/checkout@v2
- uses: ruby/setup-ruby@v1
Expand All @@ -28,19 +23,3 @@ jobs:
- name: Run unit tests
shell: bash
run: ./gradlew --continue testDevEnterpriseUnitTest
- name: Find artifacts and mapping file
shell: bash
run: |
echo ::set-output name=apk_file::$(find . -name "*.apk" | grep -v ${{env.EXCLUDE_APK_FILTER}})
echo ::set-output name=aab_file::$(find . -name "*.aab")
echo ::set-output name=mapping_file::$(find . -name mapping.txt)
id: artifacts
- name: Publish to App Center
uses: wzieba/AppCenter-Github-Action@v1.3.2
with:
appName: ${{env.APPCENTER_APP_NAME}}
token: ${{secrets.APPCENTER_API_TOKEN}}
group: ${{env.APPCENTER_GROUPS}}
file: ${{steps.artifacts.outputs.apk_file}}
releaseNotes: ${{ github.event.head_commit.message }}
notifyTesters: false
46 changes: 0 additions & 46 deletions .github/workflows/release.yml

This file was deleted.

51 changes: 26 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,44 @@

![minSdk](https://img.shields.io/badge/minSdk-21-brightgreen.svg?style=flat) ![targetSdk](https://img.shields.io/badge/targetSdk-33-brightgreen.svg?style=flat)

Welcome to the Futured Dev Academy!

Miniproject used to learn basics of Android development. Contains basic setup of project, Jetpack Compose, MVVM architecture, REST API etc.
The mini-project is to be used to learn the fundamentals of Android development in FDA. Contains the basic setup of the project, Jetpack Compose, MVVM architecture, REST API, etc.

Made by [Futured](https://futured.app).
Prepared by [Futured](https://futured.app) ♥️

## Project info
### Futured Team:

- Deadline: ~~**--. --. ----**~~
- ApplicationId: `app.futured.academyproject.`
- Supports: **Dark mode, landscape orientation**
- Design: ~~Figma/Zeplin (add link)~~
- Backend: [Mapový portál města Brna](https://gis.brno.cz)
- ~~Prod: https://live.app.com~~
- ~~Staging: https://staging.app.com~~
- Interactors: Kotlin Coroutines
- Product Flavors: mock, dev, prod
- Build Variants: debug, enterprise, release
- ~~Localizations: Czech, English – POEditor (add link)~~
- [Architecture decision records](doc/adrs.md)
- Michaela Kormošová, Head of Coordination, <michaela.kormosova@futured.app>
- David Kočnar, Android dev, <david.kocnar@futured.app>

### Team:
### Future Graduate:
- ~~Jan Novak, <jan.novak@notsofutured.app>~~

- ~~Jana Nováková, PM, <jana.novakova@futured.app>~~
- ~~Jan Novák, iOS developer, <jan.novak@futured.app>~~
- ~~John Newman, tester, <john.newman@futured.app>~~

### Used Tools
---

- Code style - **[ktlint](https://ktlint.github.io/)**, **[detekt](https://arturbosch.github.io/detekt/)**, **[Android lint](http://tools.android.com/tips/lint)**, **[Danger](https://github.com/futuredapp/danger)**

### ~~Test accounts~~
## Project info

- ~~dev - login: `a@a.com`, password: `hesloheslo`~~
- Deadline: **12. 9. 2023**
- ApplicationId: `app.futured.academyproject`
- Supports: **Dark mode, landscape orientation**
- Design: ~~Figma/Zeplin (add link)~~
- Backend: [Mapový portál města Brna](https://gis.brno.cz)
- Product Flavors: mock, dev, prod
- Build Variants: debug, enterprise, release
- Localizations: Czech

### Security standard
### Used tech

This project complies with ~~Standard (F0), High (F1), Highest (F2)~~ security standard.
- Interactors: Kotlin Coroutines + [Arkitekt UseCases](https://github.com/futuredapp/arkitekt)
- CI: GitHub Actions
- UI: [Jetpack Compose](https://developer.android.com/jetpack/compose)
- Architecture: [MVVM](https://developer.android.com/jetpack/guide)
- Dependency Injection: [Hilt](https://developer.android.com/training/dependency-injection/hilt-android)
- Networking: [Retrofit](https://square.github.io/retrofit/)
- Code style: [ktlint](https://ktlint.github.io/), [detekt](https://github.com/detekt/detekt/), [Android lint](http://tools.android.com/tips/lint), [Danger](https://github.com/futuredapp/danger)

### Additional Scripts

Expand Down
22 changes: 0 additions & 22 deletions doc/adr/0000-template.md

This file was deleted.

3 changes: 0 additions & 3 deletions doc/adrs.md

This file was deleted.

0 comments on commit 4334b41

Please sign in to comment.