Skip to content

Lionelf329/medito-app

 
 

Repository files navigation

Medito App

Meditation can positively transform people's lives. We believe no one should have to pay for it.

We are the Medito Foundation, and we've built the Medito App for people who have never meditated before or want to deepen their meditation practice.

The app is free, forever: no ads, no spam, no need to sign up or pay.

Medito App is a flutter project available on Android and iOS maintained by the Medito Foundation and its community.

Download the app

NOTE: If you istall Medito app using APK file, please make sure to verify that the APK file is signed by Medito Foundation. See VERIFY_APK for more information.

Install

GitHub release (latest SemVer)

Android iOS
Get it on Google Play
Download on the App Store

How to use this code

The best way to start is by opening the project with Android Studio or Visual Studio.

You will need an the 2 .env files to build the project. (See "Contributing" below)

To build the code you also need to run

flutter pub run pigeon --input pigeon_conf.dart and dart run build_runner watch --delete-conflicting-outputs

Need more details? Feel free to raise an issue.

Contributing

It's generally been more effort than it's worth to onboard new contributors, so we're not looking for any outside help at this time. If you would like to volunteer regardless, join our Telegram channel and go to "Discussion", then ask there for a key. Please be aware that it may take over 6 months for us to provide the details needed to build the app.

Don't feel like contributing to the code? Feature requests, feedback and suggestions are welcome. Reach us via Telegram; please don't use discord, email, or create an issue as those channels are not monitored.

About the Medito Foundation

We are a registered Dutch nonprofit:

Medito Foundation (or in Dutch "Medito Stichting") 
KvK-nummer: 75284251
RSIN: 860222627 

License

  • App: GNU AFFERO GENERAL PUBLIC LICENSE.
  • Our original content is licensed under a Creative Commons licence. For more information please refer to meditofoundation.org/license.
  • Sometimes we aggregate content from other sources that do not have the same license. This content is generally not published under "Medito". Make sure to respect the original copyright. Now that you know, we cannot be held responsible if you are miss-using this content. If you need more info, reach us on Discord or by email.

Medito Foundation https://meditofoundation.org/.

Development

Setup

  1. Clone the repository:

    git clone https://github.com/meditohq/medito-app.git
    cd medito-app
    
  2. Install dependencies:

    flutter pub get
    
  3. Set up environment files:

    • Create .env.staging and .env.production files in the root directory.
    • Contact a team member for the contents of these files.
  4. Set up Firebase:

    • You need google-services.json (for Android) and GoogleService-Info.plist (for iOS) from the Firebase console.
    • You also need the /lib/firebase_options.dart file.
    • Contact a team member for the contents of these files.

Generating Code

To generate Pigeon code. This is required to communicate with native iOS and Android code.

flutter pub run pigeon --input pigeon_conf.dart

To generate API and state management code with Riverpod:

dart run build_runner watch --delete-conflicting-outputs

Development and Production Configurations

This project supports separate development and production configurations. Here's how to set up and use them in different IDEs:

Visual Studio Code

  1. Open the project in VSCode.
  2. Go to the Run and Debug view (Ctrl+Shift+D or Cmd+Shift+D on macOS).
  3. In the dropdown at the top of the sidebar, you can choose between:
    • "Flutter (Dev)" for development configuration
    • "Flutter (Prod)" for production configuration
  4. Click the play button or press F5 to start debugging with the selected configuration.

Android Studio

  1. Open the project in Android Studio.
  2. In the toolbar, you'll see a dropdown next to the run button.
  3. Select either "Flutter (Dev)" or "Flutter (Prod)" from this dropdown.
  4. Click the run button or press Shift+F10 to run the selected configuration.

Configuration Details

  • Development configuration:

    • Entry point: lib/main_dev.dart
    • Flavor: dev
  • Production configuration:

    • Entry point: lib/main_prod.dart
    • Flavor: prod

Temp solution for iOS

  • Entry point: lib/main.dart

These configurations are defined in:

  • .vscode/launch.json for VSCode
  • .run/Flutter_Dev.run.xml and .run/Flutter_Prod.run.xml for Android Studio

Ensure that your android/app/build.gradle file has the corresponding flavor configurations set up correctly.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 87.9%
  • Kotlin 9.9%
  • Ruby 2.0%
  • Other 0.2%