200ok-ch · munen · May 31, 2022 · May 31, 2022 · May 31, 2022 · May 31, 2022
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -18,7 +18,7 @@ jobs:
           command: sudo apt-get update -yq && sudo apt install -yq lftp pandoc gvfs emacs
       - run:
           name: Deploy to https://staging.organice.200ok.ch
-          command: 'FTP_USER=${FTP_USER_STAGE} FTP_PASSWD=${FTP_PASSWD_STAGE} ./bin/compile_and_upload.sh'
+          command: 'FTP_USER=${FTP_USER_STAGE} FTP_PASSWD=${FTP_PASSWD_STAGE} make deploy'
       - run:
           name: Deploy documentation to https://staging.organice.200ok.ch/documentation.html
           command: 'FTP_USER=${FTP_USER_STAGE} FTP_PASSWD=${FTP_PASSWD_STAGE} ./bin/compile_doc_and_upload.sh'

diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 build/
+release/
 node_modules/
diff --git a/.gitignore b/.gitignore
@@ -31,3 +31,5 @@ yarn-error.log*
 /documentation.org
 
 .eslintcache
+/local.mk
+/release
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,3 @@
 build/
+release/
 node_modules/
diff --git a/Makefile b/Makefile
@@ -1,26 +1,98 @@
-SHELL = /bin/bash
+# ------------------------------------------------------------
+# includes
+
+-include .ok/credentials.mk
+-include local.mk
+
+# ------------------------------------------------------------
+# variables
+
+ANDROID_TARGET?=Pixel_3_API_32
+
+SHELL:=/bin/bash
+
+REVISION=$(shell git describe --tags)
+
+RELEASE_FILES=$(shell find release/ -type f -name '*.js')
+
+# ------------------------------------------------------------
+# functions
 
-.DEFAULT_GOAL = run
+check_defined = \
+  $(strip $(foreach 1,$1, \
+    $(call __check_defined,$1,$(strip $(value 2)))))
+__check_defined = \
+  $(if $(value $1),, \
+    $(error Undefined $1$(if $2, ($2))))
 
 # ------------------------------------------------------------
 # dev
 
+.PHONY: help
+help: ## Show this help (default)
+	@egrep -h '\s##\s' $(MAKEFILE_LIST) | \
+	  awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m  %-30s\033[0m %s\n", $$1, $$2}'
+
+# This is likely the only case in which make should call yarn.
 .PHONY: setup
-setup:
+setup: ## Setup the project
 	yarn install --production=false
+	make src/lib/headline_filter_parser.js
 
-.PHONY: run
-run: setup
-	yarn start
+.PHONY: start
+start: setup src
+start: ## Run a server that serves organice as PWA
+	npx react-scripts start
 
 .PHONY: test
-test: setup
-	yarn test
+test: setup src
+test: ## Run the tests
+	npx react-scripts test --env=jsdom
 
 .PHONY: docs
-docs:
+docs: ## Compile the documentation
 	./bin/compile_doc.sh
 
 .PHONY: deploy-docs
 deploy-docs: docs
+deploy-docs: ## Deploy the documentation
 	./bin/compile_doc_and_upload.sh
+
+build: setup src
+build: ## Build a production (pre-)build
+	bin/transient_env_vars.sh bait
+	npx react-scripts build
+
+release: build
+release: ## Build a release (with proper credentials and build number)
+	bin/transient_env_vars.sh switch build release
+	make set-revision
+
+.PHONY: set-revision
+set-revision: $(RELEASE_FILES)
+set-revision: ## Set the build revision
+	for FILE in $?; do sed -i "s/ORGANICE_ROLLING_RELEASE/$(REVISION)/" $$FILE; done
+
+.PHONY: android
+android: release
+android: ## Build the android app and run it on $ANDROID_TARGET
+	npx cap run android --target $(ANDROID_TARGET)
+
+.PHONY: check-ftp-credentials
+check-ftp-credentials: ## Check for FTP credentials
+	$(call check_defined, FTP_HOST, deployment target)
+	$(call check_defined, FTP_USER, deployment user)
+	$(call check_defined, FTP_PASSWD, deployment password)
+
+.PHONY: deploy
+deploy: check-ftp-credentials setup release
+deploy: ## Deploy organice as PWA via FTP
+	cd release && \
+	  lftp -u${FTP_USER},${FTP_PASSWD} -e "mirror -R ./; bye" ${FTP_HOST}
+
+# ------------------------------------------------------------
+# internals
+
+src/lib/headline_filter_parser.js: src/lib/headline_filter_parser.grammar.pegjs
+	echo '/* eslint-disable */' > $@
+	npx pegjs -o - $< >> $@
diff --git a/Procfile b/Procfile
@@ -1 +1 @@
-web: serve build
+web: serve release
diff --git a/README.org b/README.org
@@ -478,19 +478,19 @@ you can manually generate it with:
 ./bin/compile_search_parser.sh
 #+END_SRC
 
-** Testing
+** User Acceptance Testing
 
 When you're developing a new feature and you want to manually test it,
 it's best to check it out in a Desktop browser and on your smartphone.
 This is how you do that:
 
-*** Desktop
+*** PWA on Desktop
 
 Run the application with =yarn start= which will open organice in your
 configured default browser. Alternatively, visit
 =http://localhost:3000= in the browser of your choice.
 
-*** Smartphone
+*** PWA on Smartphone
 
 There are multiple options on how you can connect from your smartphone
 to your computer running organice.
@@ -528,6 +528,43 @@ ssh -L 3000:localhost:3000 user-dev-machine
 If you don't have a shell on your phone, you can use a dedicated SSH
 application (like [[https://www.termius.com/][Terminus]]).
 
+*** Native app on Android
+
+- Install [[https://developer.android.com/studio#downloads][Android Studio]]
+- Follow the [[https://capacitorjs.com/docs/getting-started/environment-setup#android-sdk][Capacitor Guide to setup an Android SDK]]
+
+#+begin_quote
+/:warning:/ Make sure to install the required subpackages. Activate
+"Show Package Details" to reveal hidden subpackages.
+
+At time of writing "Android API 32" does not automatically install the
+subpackages "Google APIs Intel x86 Atom_64 System Image" and "Google
+Play Intel x86 Atom_64 System Image", which are both required to run
+the Emulator on an Intel based machine.
+
+[[https://raw.githubusercontent.com/200ok-ch/organice/master/images/api_32.png]]
+#+end_quote
+
+- Create a device in Android Studio by running any app
+
+#+begin_quote
+/:monocle_face:/ Theoretically this should not be nescessary, as
+Capacitor should be able to create a device to deploy the app to on
+the fly. But this didn't work for me. After the device had be run once
+by Android Studio, Capacitor was able to start it on its own.
+#+end_quote
+
+- Shut down Android Studio and any running Emulator
+- Before run organice as a native app you need to =yarn build= it
+- Run organice in the Emulater with =npx cap run android=
+
+*** TODO Native app on iOS
+
+#+begin_quote
+/:sparkles:/ This is brand new section that wants to be written.
+Please check out how to [[#contributions][contribute to organice]].
+#+end_quote
+
 ** Debugging Tests
 
 Apart from the popular choice of =console.log=-debugging, it's easy to
@@ -575,6 +612,9 @@ merging a pull request to =develop=, code and documentation are
 automatically deployed to stage.
 
 ** Contributions
+  :PROPERTIES:
+  :CUSTOM_ID: contributions
+  :END:
 
 Please see our [[https://github.com/200ok-ch/organice/blob/master/CONTRIBUTING.org][contributor guidelines]] and our [[https://github.com/200ok-ch/organice/blob/master/CODE_OF_CONDUCT.md][code of conduct]].
 

diff --git a/android/.gitignore b/android/.gitignore
@@ -0,0 +1,96 @@
+# Using Android gitignore template: https://github.com/github/gitignore/blob/HEAD/Android.gitignore
+
+# Built application files
+*.apk
+*.aar
+*.ap_
+*.aab
+
+# Files for the ART/Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+out/
+#  Uncomment the following line in case you need and you don't have the release build type files in your app
+# release/
+
+# Gradle files
+.gradle/
+build/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Proguard folder generated by Eclipse
+proguard/
+
+# Log Files
+*.log
+
+# Android Studio Navigation editor temp files
+.navigation/
+
+# Android Studio captures folder
+captures/
+
+# IntelliJ
+*.iml
+.idea/workspace.xml
+.idea/tasks.xml
+.idea/gradle.xml
+.idea/assetWizardSettings.xml
+.idea/dictionaries
+.idea/libraries
+# Android Studio 3 in .gitignore file.
+.idea/caches
+.idea/modules.xml
+# Comment next line if keeping position of elements in Navigation Editor is relevant for you
+.idea/navEditor.xml
+
+# Keystore files
+# Uncomment the following lines if you do not want to check your keystore files in.
+#*.jks
+#*.keystore
+
+# External native build folder generated in Android Studio 2.2 and later
+.externalNativeBuild
+.cxx/
+
+# Google Services (e.g. APIs or Firebase)
+# google-services.json
+
+# Freeline
+freeline.py
+freeline/
+freeline_project_description.json
+
+# fastlane
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots
+fastlane/test_output
+fastlane/readme.md
+
+# Version control
+vcs.xml
+
+# lint
+lint/intermediates/
+lint/generated/
+lint/outputs/
+lint/tmp/
+# lint/reports/
+
+# Android Profiling
+*.hprof
+
+# Cordova plugins for Capacitor
+capacitor-cordova-android-plugins
+
+# Copied web assets
+app/src/main/assets/public
diff --git a/android/Gemfile b/android/Gemfile
@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "fastlane"