https://github.com/automattic/pocket-casts-android

Pocket Casts Android 🎧
https://github.com/automattic/pocket-casts-android

android pocket-casts

Last synced: about 1 month ago
JSON representation

Pocket Casts Android 🎧

• Host: GitHub
• URL: https://github.com/automattic/pocket-casts-android
• Owner: Automattic
• License: mpl-2.0
• Created: 2022-06-15T12:41:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T18:44:23.000Z (7 months ago)
• Last Synced: 2024-04-14T02:52:29.178Z (7 months ago)
• Topics: android, pocket-casts
• Language: Kotlin
• Homepage:
• Size: 40 MB
• Stars: 2,468
• Watchers: 28
• Forks: 203
• Open Issues: 277
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE-OF-CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


    

    





    

    





    Pocket Casts is the world's most powerful podcast platform, an app by listeners, for listeners.



## Install

If you're just looking to install Pocket Casts Android, you can find it on [Google Play](https://play.google.com/store/apps/details?id=au.com.shiftyjelly.pocketcasts). If you're a developer wanting to contribute, read on.

## Build Instructions

1. Make sure you've installed [Android Studio](https://developer.android.com/studio/index.html).

2. In Android Studio, open the project from the local repository.

3. Go to Tools → Device Manager and create an emulated device.

4. Go to Run → Edit Configurations… and create an Android App configuration. 

5. Select the module "pocketcasts-android.app.main".

6. Run.

## Build and Test

To build, install, and test the project from the command line:

    $ ./gradlew :app:assembleDebugProd          # assemble the debug .apk

    $ ./gradlew :app:installDebugProd           # install the debug .apk to a connected device

    $ ./gradlew :app:testDebugUnitTest          # assemble, install and run unit tests

    $ ./gradlew :app:connectedDebugAndroidTest  # assemble, install and run Android tests

## Directory structure

    .

    ├── app                    # Mobile app

    ├── automotive             # Automotive app

    ├── modules

    │   ├── features

    │   │   ├── account        # Create account and sign in pages.

    │   │   ├── cartheme       # Automotive resources needed for the account pages.

    │   │   ├── discover       # Discover section.

    │   │   ├── endofyear      # End of year stats.

    │   │   ├── filters        # Filters section.

    │   │   ├── navigation     # Navigation utilities.

    │   │   ├── player         # Full screen player

    │   │   ├── podcasts       # Podcasts section.

    │   │   ├── profile        # Profile section.

    │   │   ├── search         # Search pages.

    │   │   ├── settings       # Settings pages.

    │   │   └── taskerplugin   # Plugin for integration with Tasker app.

    │   └── services

    │       ├── analytics      # Analytics code.

    │       ├── compose        # Shared Compose code.

    │       ├── images         # Image resources.

    │       ├── localization   # Contains the strings in English and localized strings from GlotPress. 

    │       ├── model          # The database logic and entities. Also transfer objects required which aren't stored in the database.

    │       ├── preferences    # Stores the user preferences and configuration settings.

    │       ├── repositories   # Provides accessing to the data from the 'servers' and 'model' modules.

    │       ├── servers        # Provides the network calls to the servers. The UI layer should access these through the 'repositories' module.

    │       ├── ui             # Shared UI code for the 'compose' and 'views' modules. This includes the themes.

    │       ├── utils          # Utility classes.

    │       └── views          # Shred Only the old views code.

The hierarchy of the modules in the project are reflected in [this diagram](docs/module-diagram.png).

## Contributing

Read our [Contributing Guide](CONTRIBUTING.md) to learn about reporting issues, contributing code, and more ways to contribute.

## Documentation

- [Coding Style](docs/coding-style.md) - guidelines and validation and auto-formatting tools

- [Pull Request Guidelines](docs/pull-request-guidelines.md) - branch naming and how to write good pull requests

- [Translations](docs/translations.md) - how the app gets translated and how to contribute translations

## Signing a Release

To build a _signed_ release, add these lines to your local.properties file

    signingKeyStoreFile=/Users/username/git/secret.keystore

    signingKeyStorePassword=

    signingKeyAlias=

    signingKeyPassword=