Jarvis, create a README.md file for this repository that manipulates people into contributing to the project.

ironman

Building an App

Building an app is as easy as:

nix build .#app-name

Analyzing an APK File

First build the app

nix build .#mihon

Then use apktool to decode the APK file

nix run nixpkgs#apktool -- d result

Adding a New App

Derivation Metadata

A derivation's metadata gives information regarding the application and its target android environment.

An example of a proper metadata field for an android application is as follows:

meta = {
  description = "An open source flashcard app for spaced repetition learning";
  homepage = "https://mihon.app";
  license = lib.licenses.asl20;
  maintainers = with lib.maintainers; [ osbm ]; # from nixpkgs maintainers list
  android = {
    minSdk = 26;
    targetSdk = 36;
    applicationId = "app.mihon";
    abis = [
      "armeabi-v7a"
      "arm64-v8a"
      "x86"
      "x86_64"
    ];
  };
};

Homepage

The homepage URL of the application. If it does not have a homepage, you can use the repository URL.

License

The license under which the application is distributed. You can use licenses from lib.licenses in nixpkgs.

Maintainers

A list of maintainers for the derivation. You can use maintainers from lib.maintainers in nixpkgs.

TODO: what happens if the maintainer is not in the nixpkgs maintainers list?

Android

Metadata specific to the Android application, including SDK versions, application ID, and supported ABIs.

minSdk

The minimum SDK version required to run the application.

targetSdk

The target SDK version for which the application is optimized.

applicationId

The unique application ID (package name) for the Android application.

abis

A list of supported ABIs (Application Binary Interfaces) for the application. Common values include:

armeabi-v7a
arm64-v8a
x86
x86_64

ROADMAP

The thing is, I am a very shitty developer. And my capabilities are extremely limited. But I am ambitious so nix is perfect for me 😭.

Add CI that builds all apps on every commit.
Design a proper meta field for the needs of android apps.
- description
- license
- main page
- maintainers
- minSdkVersion (explain what is this)
- targetSdkVersion (explain what is this)
- abi (list of supported abis: armeabi-v7a, arm64-v8a, x86, x86_64)
- applicationID (the unique identifier of the app, e.g. com.example.app)
Check the meta field
Add documentation on github pages.
Add first flutter app.
Add first react-native app.
Add first ionic app.
Support building apps on more platforms (currently only x86_64-linux is supported)
After adding 10 different apps (they all must be successfully built) ask to migrate this repo to the nix-community github organization.
Have base functional coverage See functional-coverage
Check if the apk can be installed (hopefully on multiple architectures)
Check if the output derivation has any runtime dependencies (it should not)
Check if the app got an update (maybe from fdroid or github releases) and create a PR automatically.
Add binary cache
Prepare reproducibility report
Compile an application without using any maven repository (fetch all dependencies from their respective sources and compile them into jar files and feed the resulting jars to the apk build process) (this is probably impossible but worth a try)

BASIC FUNCTIONAL COVERAGE

The idea is that we should be able to have all the basic functionalities of a smartphone just by using Free and Open Source Software (FOSS) applications available in this repository. 1 app per functionality is enough for now.

Phone (dialling / contacts)
Messaging / SMS
Mail / email
Browser / web access
Calendar / scheduling
Clock / alarms & timers
Calculator / conversions
- Fossify-Calculator
Settings / device control & preferences
File manager / storage browser
Gallery / photos & media
Camera
Games & entertainment
Productivity / notes / to-do
- Fossify-Notes
Networking / VPN
Media player / video playback
Music player / audio playback
Social / communication (chat, video calls)
Off grid communication
Navigation / maps / GPS
Office suite / document editing
PDF viewer / reading
Terminal / command line access / emulator

nixapks